CoWork Befehl

Der CoWork Befehl-Trigger erlaubt es, Befehle zu definieren, die vom INETAPP-Chat aus verwendet werden, um eine Task Planner Aufgabe auszuführen. Dies erlaubt z.B. das Ausführen einer Backup-Aufgabe, das Ausführen eines Berichts oder das Versenden von E-Mails mit Hilfe eines Befehls.

Der Trigger benötigt zwei Parameter:

  • Befehl - wird im Chat-Fenster eingegeben, um die Aufgabe auszuführen
  • Beschreibung - wird bei der Eingabe des Befehls im Chat-Fenster angezeigt.

Sobald ein Befehl registriert wurde, steht dieser in der CoWork-Anwendung zur Verwendung bereit. Es gibt eine Einschränkung für die Verwendung dieses Befehls, die von den Zugriffsrechten des Benutzers abhängt, der den Task in der Taskverwaltung erstellt hat (oder besitzt).

Hinweis: Benutzerdefinierte Befehle werden für einen Kanal auf der Hilfeseite des Bots angezeigt, wenn man / im Chatfenster eingibt.

Hinweis: Die Eingabe von Befehlen im Chatfenster muss mit / gestartet werden.

Befehl

Der Befehl besteht aus einem oder mehreren Schlüsselwörtern. Zusätzliche Eingaben, die im Chat nach dem Befehl erfolgen, werden als Parameter verwendet und stehen als Platzhalter in der Task Planner Aufgabe zur Verfügung.

Um anzuzeigen, dass ein Befehl mit Parametern erweitert werden kann - oder um einen Hinweis auf die Syntax der Parameter zu geben, kann ein Hinweis in die Befehlszeile eingefügt werden. Der Hinweis besteht aus einem beginnenden # oder < und wird im Chatfenster farblich anders dargestellt.

Beispiel: Befehl zur Anzeige der Wetterbedingungen ohne Parameterangabe

Wetter anzeigen

Beispiel: Befehle zur Anzeige der Wetterbedingungen mit Parameterangabe

Wetter anzeigen #hier die Stadt eingeben

Wetter anzeigen <Stadt>

Hinweis: Bei Verwendung von # als Parametererweiterung ist das #-Symbol Teil des Befehls, was für IDs, die dieses Format erfordern, nützlich ist. Das <-Symbol ist nicht Teil des resultierenden Befehls.

Hinweis: Ein Befehl kann nur einmal registriert werden. Wenn ein anderer Benutzer versucht, den selben Befehl erneut zu registrieren, wird eine Fehlermeldung angezeigt, dass dieser Befehl bereits registriert wurde.

Platzhalter

Es gibt eine Reihe von Platzhaltern, die dem Job und der Aktion der Aufgabe übergeben werden:

  • {cowork.command.channelid} - die ID des CoWork-Kanals
  • {cowork.command.name} - der Name des ausgelösten Befehls
  • {cowork.command.parameters} - zusätzliche Befehlsparameter
  • {cowork.command.parameter1} ... {cowork.command.parameter9} - zusätzliche Kommando-Parameterteile, getrennt durch Leerzeichen. Parameter können zusätzlich mit doppelten Anführungszeichen versehen werden.
  • {cowork.command.userid} - die ID des Benutzers, der den Befehl ausgelöst hat

Hinweis: {cowork.command.parameters} enthält die vollständige Parameterfolge und wird in einem CoWork-Chat direkt nach dem Befehl angegeben. Bis zu neun Parameter können einzeln mit den Platzhaltern {cowork.command.parameter1} bis {cowork.command.parameter9} abgefragt werden.

Einschränkung für die Verwendung

Die folgenden Einschränkungen gelten für die Verwendung eines Befehls für andere Benutzer als den Aufgabenbesitzer:

  • Wenn der Aufgabenbesitzer ein CoWork-Administrator ist: jeder andere Benutzer kann den Befehl in jedem Kanal verwenden, auch in direkten Nachrichtenkonversationen.
  • Wenn der Aufgabenbesitzer ein Teamadministrator ist: Jeder Benutzer, der Mitglied des Teams ist, kann den Befehl in den Teamkanälen verwenden
  • Wenn der Aufgabenbesitzer ein Kanal-Benutzer ist: jeder andere Benutzer kann den Befehl in den Kanälen verwenden, in denen der Aufgabenbesitzer Mitglied ist, auch in direkten Nachrichtenkonversationen.

Beispiel: Befehl für OpenWeatherMap

Dieses Beispiel zeigt einen Befehls-Trigger, der das OpenWeatherMap-Plugin ausführt und das Ergebnis an den Kanal des Benutzers zurückgibt.

Die folgenden Elemente werden konfiguriert:

  • CoWork Befehl Trigger: mit dem Befehl Wetter <City>. Der zusätzliche Parameter für die Stadt wird als Platzhalter dargestellt, um anzuzeigen, dass zusätzliche Eingaben als cowork.command.parameter verwendet werden sollen.
  • OpenWeatherMap Job: der Platzhalter cowork.command.parameter wird als Standort für die Abfrage verwendet.
  • CoWork Nachricht Aktion: die Antwort des Jobs wird nun mit dem Platzhalter cowork.command.channel an den ursprünglichen Kanal zurückgeschickt. Die Nachricht für den Kanal wird aus weiteren Platzhaltern zusammengesetzt, um den ursprünglichen Benutzer, die Eingabeparameter des Befehls und die Antwort des OpenWeatherMap-Plugins auszugeben.
    • Beachten Sie, dass der Kanal entweder ausgewählt oder ein Platzhalter verwendet werden kann.

Die Ausführung des Befehls im Chatfenster sieht wie folgt aus: