EINFÜHRUNG IN SKRIPTE

Überblick über die Skripte

CDESK bietet die Möglichkeit, eigene Skripte zur Automatisierung von Prozessen in Ihrem Arbeitsalltag zu erstellen. Diese Skripte funktionieren unabhängig von CDESK und verwenden die API, um Daten abzurufen und zurückzusenden, sodass sie von einem beliebigen Computer, Server oder Cloud-Dienst ausgeführt werden können.

Wir stellen einige Beispielskripte in zwei Varianten bereit:

1. Dockerisierte CDESK-Python-Skripte
2. CDESK-Skripte, die Azure-Dienste nutzen

Zur Umsetzung eines eigenen Szenarios kann jede dieser Methoden gewählt werden, allgemein eignen sich die Skripte in Azure jedoch aufgrund der einfachen Wartung besser für kleinere Szenarien, falls Sie nicht viel Erfahrung mit Cloud-Diensten haben. Andererseits sind die Python-Skripte flexibler, da sie sich leichter testen, einstellen und verwalten lassen. Wenn sie auf einem lokalen Computer oder Server laufen, ist ihr Betrieb kostenlos, da sie – anders als die meisten Cloud-Dienste – keine Kosten für die Betriebszeit oder die Anzahl der API-Aufrufe verursachen. Sie erfordern jedoch Programmierkenntnisse und Grundlagen im Umgang mit Docker. Die Wahl der geeigneten Variante hängt also von Ihrer Situation ab.

Dockerisierte CDESK-Python-Skripte

Für die Nutzung dockerisierter CDESK-Skripte benötigen Sie Docker auf Ihrem Computer installiert. Am wichtigsten ist die Docker CLI (cmd, Bash, sh usw.), wobei die Docker Desktop GUI eine nützliche Ergänzung für weniger erfahrene Benutzer ist. Die Installationsanleitung und Links finden Sie auf der offiziellen Seite.

Wir empfehlen außerdem, Python für die lokale Entwicklung zu installieren, damit die Skripte auch ohne Erstellung eines Docker-Containers getestet werden können.

Vor Beginn der Arbeit mit den Skripten wird empfohlen, die Anwendung Support CDESK Scripts einzurichten, die zur Anzeige der Skript-Logs und zum manuellen Ausführen vorhandener Skripte dient. Diese Anwendung verwendet kein Docker, sondern läuft direkt auf dem lokalen Computer. Aus Sicherheitsgründen und wegen technischer Komplikationen ist sie nicht Teil der CDESK-Anwendung und von außen nicht zugänglich, sodass der Zugriff auf den PC/Server beschränkt ist, auf dem die Anwendung läuft. Es wird empfohlen, diese Anwendung zur einfacheren Verwaltung der Skripte zu haben, sie funktionieren jedoch auch ohne sie.

CDESK-Skripte, die Azure nutzen

Zum Ausführen von CDESK-Skripten in Azure benötigen Sie ein grundlegendes Verständnis der Dienste, die Azure bereitstellt. Für einfache Szenarien, in denen nicht viele API-Aufrufe durchgeführt werden und keine komplizierte Datenverarbeitung erfolgt, können Sie Azure Logic Apps verwenden (mehr Informationen finden Sie in diesem Handbuch). Für komplexere Szenarien sollten Sie andere Dienste in Betracht ziehen, wie zum Beispiel Container Instance oder Function App. Diese Dienste ermöglichen das Hosten größerer Skripte mit mehreren Quellcodedateien, API-Aufrufen und komplexer Datenverarbeitung.

Wo bestimmte Daten in CDESK zu finden sind

Verschiedene Szenarien erfordern mit Sicherheit Informationen über die IDs von CDESK-Objekten, um diese zu erstellen oder zu bearbeiten. Um die Objekte nach Ihren Bedürfnissen abzurufen, müssen Sie SB-Filter verwenden. Diese Daten sind nicht schwer zu finden, und die einzige Voraussetzung ist der Zugriff auf Ihr CDESK.

Objekt-ID

Die Objekt-ID ist eine Information, die üblicherweise im Rahmen der Entwicklung verwendet wird. Deshalb wird sie nicht direkt an den Objekten angezeigt. Um sie zu finden, gehen Sie zum gewünschten Objekt (Anforderung, Bericht, Unternehmen, Benutzer usw.) und suchen Sie die ID in der URL-Adresse.

SB-Filter der Objekte

Dieser Filter wird in CDESK üblicherweise für verschiedene Objekte verwendet, wie Anforderungen, Berichte, Deals, Aufgaben und andere. Für den Zugriff auf die SB-Filter müssen Sie dem Konto, das sie verwenden wird, die entsprechende ACL-Berechtigung hinzufügen.

1. Melden Sie sich als lokaler Administrator in CDESK an.
2. Gehen Sie im linken Menü zu Benutzer und Gruppen -> Benutzer und wählen Sie den Benutzer aus, dem Sie die Berechtigung für die Debug-Werkzeuge hinzufügen möchten.
3. Suchen Sie im Abschnitt Berechtigungen den Eintrag Entwicklerwerkzeuge in der ACL-Liste. Aktivieren Sie ihn für den Benutzer und speichern Sie die Änderungen.

Gehen Sie anschließend zu Berechtigungen und suchen Sie in der ACL-Liste die Entwicklerwerkzeuge. Aktivieren Sie sie für diesen Benutzer und speichern Sie die Änderungen.

Nun sollte Ihnen die rote Schaltfläche DEBUG angezeigt werden, die die aktuell verwendeten SB-Filter anzeigt/ausblendet. Falls Sie sie nicht sehen, klicken Sie auf die Schaltfläche Erweiterte Suche anzeigen.

Der SB-Filter ist als JSON-Objekt erstellt, das Felder und angewendete Filter enthält. Dieses JSON wird dann in das base64-Format kodiert und in GET-API-Aufrufen verwendet.