Mikroapps

Integration von Smartsheet

Mit der Smartsheet-Integration können Sie Blätter, Diskussionen, Aktualisierungsanforderungen und Anlagen verwalten.

Ausführliche Details zu vorkonfigurierten Mikroapps für Smartsheet finden Sie unter Verwenden von Smartsheet-Mikroapps.

Hinweis:

Diese Smartsheet-Integrationsvorlage wird in der Kategorie Citrix Labs veröffentlicht. Auf diese Weise kann die Funktionalität basierend auf erstem Kundenfeedback weiter optimiert werden. Bei Citrix Labs-Vorlagen unterstützt der Entwickler die Vorlage nach bestem Bemühen, es besteht jedoch keine Supportverpflichtung. Citrix Labs-Integrationsvorlagen werden zum Testen und Validieren freigegeben. Wir raten davon ab, sie in Produktionsumgebungen bereitzustellen. Citrix Labs-Vorlagen sind in einem separaten Abschnitt aufgeführt. Senden Sie uns Ihr Feedback! Wir freuen uns über Ihr Feedback zu dieser Integrationsvorlage. Unser Team überprüft unser zugehöriges Forum täglich auf gemeldete Probleme.

Prüfung der Voraussetzungen

Es wird hier davon ausgegangen, dass der Administrator zur Smartsheet-Integration gehört, die von der Organisation eingerichtet wurde. Dieses Smartsheet-Administratorkonto muss über volle Leserechte für alle Benutzer- und Blattinformationen verfügen.

Nach dem Einrichten dieser Integration mit Smartsheet benötigen Sie diese Artefakte, um die Integration in Citrix Workspace-Mikroapps hinzuzufügen:

  • Basis-URL: https://api.smartsheet.com/.
  • Autorisierungs-URL: https://app.smartsheet.com/b/authorize
  • Token-URL: https://api.smartsheet.com/2.0/token
  • Client-ID: Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies als Anwendungsschlüssel beim Konfigurieren des OAuth-Servers.
  • Geheimer Clientschlüssel: Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen dies als Anwendungsschlüssel beim Konfigurieren des OAuth-Servers.

Hinweis:

Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.

Konfigurieren Sie in Citrix Gateway die Unterstützung für Single Sign-On für Blackboard, damit Benutzer sich nur einmal anmelden und ihre Anmeldeinformationen nicht erneut eingeben müssen. Weitere Hinweise zum Konfigurieren von SSO finden Sie unter Citrix Gateway Service.

Erstellen eines Dienstkontos

Für die Integration ist ein regulärer Zugriff auf Ihre Smartsheet-Instanz erforderlich. Wir empfehlen daher, ein dediziertes Benutzerkonto zu erstellen. Dieses Konto muss über die folgenden Berechtigungen für Ihr Dienstkonto verfügen: Volle Administratorrechte. Sie können die Berechtigungen mit https://admin.smartsheet.com anzeigen.

Zum Erstellen eines Dienstkontos registrieren Sie sich hier: https://app.smartsheet.com/b/signup. Stellen Sie sicher, dass das kostenpflichtige Konto verfügbar ist, um ein neues Dienstkonto zu erstellen.

Wenn beim Einrichten des neuen Dienstkontos Probleme auftreten, wenden Sie sich bitte an das entsprechende Vertriebs- oder Kundensupportteam: https://www.smartsheet.com/contact/sales?fts=contact.

API-Zugriff

Sie können nur eine begrenzte Anzahl an API-Anforderungen an bestimmte Ressourcen stellen. Daher empfehlen wir Folgendes:

Smartsheet-APIs sind standardmäßig in Open Source verfügbar.

Konfigurieren des OAuth-Servers

Konfigurieren Sie den OAuth-Server so, dass Daten über die Smartsheet-Integration gelesen werden.

  1. Navigieren Sie zu https://developers.smartsheet.com/register/ und geben Sie die E-Mail-Adresse des Dienstkontoadministrators ein.
  2. Wählen Sie Register Developer Account.
  3. Suchen Sie im Posteingang des Dienstkontoadministrators nach einer E-Mail von Smartsheet.
  4. Wählen Sie den Link. Sie werden dann weitergeleitet zu https://app.smartsheet.com.
  5. Ein Dialogfeld zum Erstellen einer neuen App wird angezeigt. Wählen Sie im Entwicklerprofilbereich die Option Create New App.
  6. Füllen Sie die erforderlichen Felder aus, darunter den App-Namen, die Beschreibung, die URL und eine E-Mail für Kontakt/Support.
  7. Geben Sie im Feld “Redirect URL” folgende autorisierte Umleitungs-URLs für die App ein:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  8. Aktivieren Sie das Kontrollkästchen “Publish App” und wählen Sie Save.
  9. Kopieren und speichern Sie die angezeigten Angaben für ClientId und Secret. Verwenden Sie diese Details für die Dienstauthentifizierung, während Sie die Integration konfigurieren.

Konfigurieren des OAuth-Client

Konfigurieren Sie den OAuth-Client so, dass Daten über die Smartsheet-Integration zurückgeschrieben werden.

  1. Wählen Sie wie im Schritt 5 weiter oben im Entwicklerprofilbereich die Option Create New App.
  2. Füllen Sie die erforderlichen Felder aus, darunter den App-Namen, die Beschreibung, die URL und eine E-Mail für Kontakt/Support.
  3. Geben Sie im Feld “Redirect URL” folgende autorisierte Umleitungs-URLs für die App ein:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serviceAction/callback
  4. Aktivieren Sie das Kontrollkästchen “Publish App” und wählen Sie Save.
  5. Kopieren und speichern Sie die angezeigten Angaben für ClientId und Secret. Verwenden Sie diese Details für die Dienstaktionsauthentifizierung, während Sie die Integration konfigurieren.
  6. Wählen Sie Schließen.

Hinzufügen der Integration zu Citrix Workspace-Mikroapps

Fügen Sie die Smartsheet-Integration zu Citrix Workspace-Mikroapps hinzu, um eine Verbindung zu Ihrer Anwendung herzustellen. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Dadurch werden vorkonfigurierte Mikroapps mit Benachrichtigungen und Aktionen bereitgestellt, die in Ihrem Workspace sofort einsatzbereit sind.

Führen Sie die folgenden Schritte aus:

  1. Wählen Sie auf der Seite Mikroappintegrationen die Optionen Neue Integration hinzufügen und Neue Integration aus Citrix-Vorlagen hinzufügen.
  2. Wählen Sie die Smartsheet-Kachel.
  3. Geben Sie einen Integrationsnamen ein.
  4. Geben Sie Connectorparameter ein.
    • Geben Sie die Basis-URL der Instanz ein:
    • Wählen Sie ein Symbol für die Integration aus der Symbolbibliothek aus, oder belassen Sie das Standardsymbol.
  5. Wählen Sie unter Dienstauthentifizierung im Menü Authentifizierungsmethode die Option OAuth 2.0 und füllen Sie die Authentifizierungsdetails aus. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Generieren Sie über das Sicherheitsprotokoll OAuth 2.0 einen Anforderungs-/Autorisierungstoken zum delegierten Zugriff. Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.
    1. Wählen Sie im Menü Authentifizierungsmethode die Option OAuth 2.0 und geben Sie die Authentifizierungsdetails ein.
    2. Wählen Sie im Menü Tokenautorisierung die Option Autorisierungsheader.
    3. Die Autorisierungs-URL ist vorausgefüllt: https://app.smartsheet.com/b/authorize
    4. Die Token-URL ist vorausgefüllt: https://api.smartsheet.com/2.0/token
    5. Stellen Sie sicher, dass Folgendes als Bereich eingegeben ist: ADMIN_SHEETS ADMIN_USERS READ_SHEETS READ_USERS
    6. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies als ClientId beim Konfigurieren des OAuth-Servers.
    7. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen dies als geheimen Clientschlüssel beim Konfigurieren des OAuth-Servers.
  6. Aktivieren Sie unter Dienstaktionsauthentifizierung die Umschaltfläche Separate Benutzerauthentifizierung in Aktionen verwenden. Mit der Dienstaktionsauthentifizierung authentifizieren Sie sich auf der Dienstaktionsebene. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen.
    1. Wählen Sie im Menü Authentifizierungsmethode die Option OAuth 2.0 und geben Sie die Authentifizierungsdetails ein.
    2. Wählen Sie im Menü Tokenautorisierung die Option Autorisierungsheader.
    3. Die Autorisierungs-URL ist vorausgefüllt: https://app.smartsheet.com/b/authorize
    4. Die Token-URL ist vorausgefüllt: https://api.smartsheet.com/2.0/token
    5. Stellen Sie sicher, dass Folgendes als Bereich eingegeben ist: ADMIN_SHEETS ADMIN_USERS SHARE_SHEETS WRITE_SHEETS ADMIN_WORKSPACES
    6. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies als ClientID beim Konfigurieren des OAuth-Client.
    7. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen dies als geheimen Clientschlüssel beim Konfigurieren des OAuth-Client.
  7. Aktivieren Sie die Umschaltfläche Anforderungsratenlimit aktivieren. Geben Sie für Anzahl der Anforderungen den Wert 300 und für Zeitintervall den Wert 1 Minute ein.
  8. Das Anforderungstimeout ist auf 120 voreingestellt.
  9. (Optional) Aktivieren Sie die Umschaltfläche Protokollierung, um 24-Stunden-Protokolle für Supportzwecke zu erstellen.
  10. Wählen Sie dann Speichern.

Sie können nun die erste Datensynchronisierung festlegen und ausführen.

Synchronisierung

Aufgrund des API-Aufruflimits ist die inkrementelle Synchronisierung so eingerichtet, dass nur “List Org Sheets”, “List Org Discussions” und “Get All Org SentUpdateRequests” gespeichert werden. Die übrigen Endpunkte werden im Rahmen der vollständigen Synchronisierung ausgelöst.

Wir empfehlen, für die vollständige Synchronisierung das Intervall Täglich und für die inkrementelle Synchronisierung das Intervall Alle 5 Minuten zu wählen, um Daten von Smartsheet regelmäßig auf der Mikroapps-Plattform zu aktualisieren und zeitnahe Benachrichtigungen zu erhalten. Vollständige Informationen zu Synchronisierungsregeln, zeitlich fehlgeschlagenen Synchronisierungen und zu Vetoregeln finden Sie unter Synchronisieren von Daten.

Hinweis:

Das Paginierungslimit ist auf 100 festgelegt. Administratoren können dieses Limit je nach API erweitern.

Der Standardwert für Max. zu ladende Seiten wird wie folgt festgelegt:

Endpunktname Wert
List Org Sheets 50
List Groups 10
List Org Discussions 10
Get All Org SentUpdateRequests 10
List Sheets 50
Get Sheets 10
List Sheet Shares 10
List Groups 50

Weitere Informationen zu API-Endpunkten und Tabellenentitäten finden Sie unter Smartsheet-Connectorspezifikationen.

Verwenden von Smartsheet-Mikroapps

Vorhandene Anwendungsintegrationen werden mit vorkonfigurierten Mikroapps geliefert. Beginnen Sie mit diesen Mikroapps und passen Sie sie an Ihre Erfordernisse an.

Blatt aufrufen: Zum Anzeigen von Blättern, Freigeben eines Blatts für lizenzierte oder unlizenzierte Benutzer oder Gruppen, Hinzufügen eines Blatts als Favoriten und mehr.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Alle Blätter anzeigen” Benutzer können nach freigabefähigen und nicht freigabefähigen Blättern suchen.
Detailseite “Freigabefähiges Blatt” Ansicht mit Aktionsmöglichkeiten, in der Benutzer das Blatt als Favorit hinzufügen, das Blatt anzeigen und das Blatt für lizenzierte oder unlizenzierte Benutzer oder Gruppen freigeben können.
Detailseite “Nicht freigabefähiges Blatt” Ansicht, in der Benutzer das Blatt als Favorit hinzufügen und das Blatt anzeigen können.
Detailseite “Freigabefähiges Gruppenblatt” Ansicht mit Aktionsmöglichkeiten, in der Benutzer das Blatt als Favorit hinzufügen, das Blatt anzeigen und das Blatt für lizenzierte oder unlizenzierte Benutzer oder Gruppen freigeben können.
Detailseite “Nicht freigabefähiges Gruppenblatt” Ansicht, in der Benutzer das Gruppenblatt als Favorit hinzufügen und das Gruppenblatt anzeigen können.

Blatt erstellen: Erstellen eines neues Blatts mit Feldern und Optionen wie dem Blattnamen, Eingabe eines Spaltentitels, Auswahl des Spaltentyps und Auswahl der primären Spalte.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Blatt erstellen” Formular zum Erstellen eines neuen Blatts.

Diskussion: Generieren von Benachrichtigungen an den Benutzer, der die Diskussion erstellt hat, sobald eine neue Antwort im Diskussionsthread vorliegt.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung: Neuer Kommentar zu Ihrer Diskussion hinzugefügt Sobald eine Antwort bzw. ein Kommentar zu einer vorhandenen Diskussion eingeht, wird der Benutzer benachrichtigt, der die Diskussion erstellt hat.
Detailseite “Diskussion” Formular zum Antworten auf den Diskussionsthread und Anzeigen vorheriger Kommentare.

Meine Aktualisierungsanforderungen: Anzeigen gesendeter und erhaltener Aktualisierungsanforderungen, mit Details wie Empfänger, Absender, Betreff und Status. Wenn ein Benutzer eine Aktualisierungsanforderung sendet, erhalten Empfänger der Anforderung eine Benachrichtigung. Nach Abschluss der Aktualisierungsanforderung erhält der Absender eine entsprechende Benachrichtigung.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung: Smartsheet-Aktualisierungsanforderung erhalten Wenn ein Anforderer eine Aktualisierungsanforderung sendet, erhält der Empfänger eine Benachrichtigung.
Benachrichtigung: Smartsheet-Aktualisierungsanforderung abgeschlossen Wenn der Empfänger eine Aktualisierungsanforderung abschließt, erhält der Anforderer eine Benachrichtigung.
Seite “Alle Aktualisierungsanforderungen” Benutzer können nach gesendeten und empfangenen Aktualisierungsanforderungen suchen.
Detailseite “Gesendete Aktualisierungsanforderung” Ansicht der gesendeten Aktualisierungsanforderung mit Funktionen zum Löschen der Aktualisierungsanforderung und zur Blattanzeige.
Detailseite “Erhaltene Aktualisierungsanforderung” Schreibgeschützte Ansicht einer erhaltenen Aktualisierungsanforderung mit Funktion zur Blattanzeige.
Detailseite “Abgeschlossene Aktualisierungsanforderung” Schreibgeschützte Ansicht einer abgeschlossenen Aktualisierungsanforderung mit Funktion zur Blattanzeige.

Smartsheet als Anlage senden: Senden von Smartsheets als Anlage (PDF oder Excel), mit Details wie E-Mail, Betreff und Nachricht.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Alle Blätter anzeigen” Benutzer können nach Blättern suchen, deren Inhaber sie sind.
Detailseite “Als E-Mail senden” Ansicht mit Aktionsmöglichkeiten, um ein Smartsheet-Blatt als Anlage (PDF/Excel) mit Betreff und/oder Nachricht zu senden.

Für Administrator freigeben: Ermöglicht Benutzern ohne Administratorrechte die schreibgeschützte Freigabe ihrer Blätter für den Administrator und das Entsperren weiterer Features wie “Blatt aufrufen” “Meine Aktualisierungsanforderungen” und “Diskussion”, und den Empfang der entsprechenden Benachrichtigung. Durch Freigabe des Blatts für den Administrator können Sie zusätzliche Smartsheet-Aktionen und Benachrichtigungen in Workspace entsperren, zum Beispiel Aktionen/Benachrichtigungen für Aktualisierungsanforderungen, Diskussionsbenachrichtigungen und das Anzeigen Ihrer Blätter.

Hinweis:

In dieser Mikroapp gibt es auf der Seite Blatt für Administrator freigeben die Auswahlkomponente Administrator-E-Mail (für Endbenutzer nicht sichtbar). Diese Komponente wird für die Freigabe von Benutzerblättern für das Administratorkonto Ihrer Organisation verwendet. Dieses Administratorkonto ist dasselbe Dienstkonto, das Sie im vorherigen Schritt eingerichtet haben. Wenn Ihre Organisation mehrere Dienst-/Administratorkonten verwendet, müssen Sie sicherstellen, dass die Auswahlkomponente Administrator-E-Mail auf das richtige Konto verweist, damit diese Mikroapp ordnungsgemäß funktioniert.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Alle Blätter anzeigen” Benutzer können eigene Blätter durchsuchen und sie bei Bedarf für den Administrator freigeben.
Detailseite “Blatt für Administrator freigeben” Ansicht mit Aktionsmöglichkeiten, um ein Blatt schreibgeschützt für den Administrator freizugeben und eine Notiz zu einem freigegebenen Blatt hinzuzufügen.
Seite “Blatt für Administrator freigegeben” Benutzer erhält Bestätigung bei Freigabe des Blattes für den Administrator.

Diskussion starten: Start einer Diskussion auf Blattebene.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Diskussion starten” Ansicht mit Aktionsmöglichkeiten zum Initiieren einer Diskussion auf Blattebene.
Integration von Smartsheet