Benutzerdefinierte Code-Snippets

Einige Skripte erfordern eine komplexere Programmierung, die über den Funktionsumfang von Studio-Aktionen hinausgeht. Studio bietet Ihnen die Möglichkeit, Ihren Skripten benutzerdefinierten Code hinzuzufügen. So können Sie Ihre Skripte an die spezifischen Anforderungen Ihres Unternehmens anpassen.

Die Erstellung von benutzerdefiniertem Code setzt Skript- oder Programmierkenntnisse voraus. Studio verwendet eine benutzerdefinierte Programmiersprache namens Snippet, die für die Verwendung in Studio entwickelt wurde. Zum Erlernen dieser Sprache steht ein vollständiges technisches Referenzhandbuch in der Online-Hilfe zur Verfügung.

Wichtige Fakten über Snippets

  • Mithilfe von Code-Snippets können Sie die Struktur und Effizienz Ihrer Skripte verbessern. Sie können damit die ausgeführten Prozesse besser steuern und genauer festlegen, wann und wie sie ausgeführt werden. Sie können eigene Variablen und Objekte erstellen und mithilfe von Anweisungen wie IF, FOR und FOREACH Programmierlogik hinzufügen.
  • Einige Produkte und Funktionen erfordern Snippets, Sie können sie aber auch dann in Ihren Skripten verwenden, wenn sie nicht zwingend erforderlich sind.
  • Wenn für ein Produkt oder eine Funktion Code-Snippets erforderlich sind, bietet die Online-Hilfe ausführliche Informationen über die Snippets, die Sie verwenden müssen. Außerdem stehen Skriptbeispiele zur Verfügung, die zeigen, wie die Code-Snippets in Skripten verwendet werden. Zum Implementieren der Produkte oder Funktionen ist möglicherweise eine weitere Skriptbearbeitung erforderlich.
  • Die Snippet-Skriptsprache basiert auf dem .NET-Framework. Sie wird serverseitig ausgeführt und in MSIL (Microsoft Intermediate Language) kompiliert, wie C# und Visual Basic .NET.

Snippet-Aktion

Damit Sie Ihren Skripten benutzerdefinierten Code hinzufügen können, benötigen Sie eine Snippet-Aktion. Sie können auf diese Aktion doppelklicken, um ein Editor-Fenster zu öffnen, in dem Sie den benutzerdefinierten Code hinzufügen können. Im Editor-Fenster können Sie Ihren Code auch debuggen. Möglicherweise ist mehr als eine Snippet-Aktion in Ihrem Skript erforderlich. Wenn Sie mehrere Aktionen verwenden, geben Sie in das Feld Caption für jede Aktion eine Beschreibung ein.

Die Platzierung einer Snippet-Aktion ist wichtig. Wenn ein Snippet einer Variablen einen Wert zuweist, muss sie vor der Aktion platziert werden, die den Wert benötigt. Wenn ein Snippet dagegen Code für eine Entscheidung enthält, die sich nach dem an sie übergebenen Wert richtet, muss das Snippet nach der Aktion platziert werden, die den Wert bereitstellt.

Snippets im Vergleich mit Aktionen

Einige Aufgaben, die Snippets durchführen können, lassen sich auch mithilfe von Studio-Aktionen implementieren. Beispielsweise gibt es Aktionen für die Anweisungen IF und FOR. Mit der Aktion ASSIGN können Sie eine benutzerdefinierte Variable erstellen und ihr einen Wert zuweisen. Diese Aktionen bieten eine akzeptable Methode, um Ihrem Skript die entsprechende Funktionalität hinzuzufügen. Snippets sind jedoch effizienter.

In Snippets platzierter Code hat mehrere Vorteile: Ihr Skript ist übersichtlicher und besser strukturiert und Sie können einfacher im Skript navigieren. Dadurch wird die Skripterstellung einfacher und effizienter. Wenn Sie es sich angewöhnen, Variablen immer in Snippets zu deklarieren, ist die Suche nach einer bestimmten Deklaration in Zukunft einfacher, da weniger Orte durchsucht werden müssen.

Hinzufügen von benutzerdefiniertem Code zu einem Skript

Mithilfe der Snippet-Aktion können Sie Ihren Skripten benutzerdefinierten Code hinzufügen. Sie finden diese Aktion auf der Registerkarte "Extras" im Bereich "Erweitert" der Standardpalette.

  1. Öffnen Sie Ihr Skript in Studio.
  2. Fügen Sie an der Stelle, an der der Code erforderlich ist, eine Snippet-Aktion in Ihr Skript ein und verbinden Sie sie mit den anderen Aktionen.
  3. Doppelklicken Sie auf die Aktion, um das Editor-Fenster zu öffnen. Hier können Sie Ihren Code hinzufügen.

  4. Klicken Sie auf die Registerkarte, auf der Sie den Code hinzufügen möchten. Jede Registerkarte bietet eine eigene Methode zum Hinzufügen von Code. Folgende Registerkarten sind verfügbar:

  5. Debuggen Sie Ihren Code, sofern gewünscht.

  6. Sie können Ihre Änderungen jederzeit speichern, ohne das Editor-Fenster zu schließen, indem Sie auf Apply klicken.
  7. Klicken Sie auf OK, wenn Sie die Bearbeitung des Codes abgeschlossen haben.

Code mit Textansicht

Über die Registerkarte "Textansicht" im Snippet-Fenster können Sie Ihren Snippet Code von Hand schreiben. Zum Erlernen dieser Sprache steht ein vollständiger Referenzleitfaden in der Online-Hilfe zur Verfügung.

  1. Öffnen Sie Ihr Skript in Studio.
  2. Fügen Sie die Snippet Aktion zu Ihrem Skript hinzu und doppelklicken Sie darauf, um das Snippet-Fenster zu öffnen.
  3. Geben Sie auf der linken Seite der Registerkarte "Strukturansicht" Ihren Code ein. Sie können den Code eintippen oder aus einer anderen Quelle kopieren und einfügen, beispielsweise von dieser Hilfeseite oder aus einem anderen Skript.
  4. Sie können jederzeit auf die Registerkarte Tree View klicken, um Code aus den vordefinierten Schlüsselwörtern hinzuzufügen. Mit den nach oben und unten gerichteten Pfeilen können Sie den Code für ein Schlüsselwort an eine andere Stelle im Skript verschieben.
  5. Klicken Sie auf das Symbol Check Syntax Das Symbol Syntax überprüfen, drei kleine grüne Kreise mit einem Dreieck, das nach rechts zeigt., um zu überprüfen, ob die Syntax für den vorliegenden Code korrekt ist. Wenn keine Fehler vorliegen, wird im Status-Feld in der Symbolleiste unten auf der Registerkarte "Textansicht" der Status Okay angezeigt. Wenn Fehler vorhanden sind, wird eine Fehlermeldung eingeblendet und im Status-Feld in der Symbolleiste wird eine Meldung angezeigt. Die Meldung kann zum Beispiel folgendermaßen lauten: Error at line 4.
  6. Klicken Sie auf das Symbol Comment Das Symbol Kommentar, eine öffnende und eine schließende spitze Klammer mit einem blauen Schrägstrich dazwischen., um die Zeile, in der sich der Cursor gerade befindet, in einen Kommentar umzuwandeln.
  7. Klicken Sie auf das Symbol Uncomment Das Symbol Kommentar entfernen, ein großer roter Schrägstrich über einer öffnenden und einer schließenden spitzen Klammer mit einem Schrägstrich dazwischen., um die Kommentarzeichen aus der Zeile zu entfernen, in der sich der Cursor gerade befindet.
  8. Sie können Ihre Änderungen jederzeit speichern, ohne das Editor-Fenster zu schließen, indem Sie auf Apply klicken.
  9. Klicken Sie auf OK, wenn Sie die Bearbeitung des Codes abgeschlossen haben.

Code mit Strukturansicht

Auf der Registerkarte "Strukturansicht" im Fenster "Snippet-Eigenschaften" werden Sie Schritt für Schritt durch die Erstellung von benutzerdefiniertem Code geführt. Dabei stehen vordefinierte Schlüsselwörter zur Auswahl.

  1. Öffnen Sie Ihr Skript in Studio.
  2. Fügen Sie Ihrem Skript die Snippet-Aktion hinzu und doppelklicken Sie darauf, um das Snippet-Fenster zu öffnen.
  3. Klicken Sie unten auf der Registerkarte "Strukturansicht" auf das Pluszeichen Ein Pluszeichen mit einem nach unten gerichteten Pfeil..

  4. Das Fenster Snippet-Eigenschaften mit der Registerkarte Strukturansicht. Das grüne Pluszeichen ist gedrückt und das Menü mit den Snippet-Befehlen ist sichtbar.

    Wählen Sie das Schlüsselwort aus, das Sie Ihrem Code hinzufügen möchten.
  5. Klicken Sie auf das Schlüsselwort, das in der Liste auf der linken Seite des Fensters angezeigt wird, um seine Eigenschaften einzublenden.

  6. Konfigurieren Sie die Eigenschaften des Schlüsselworts in der Liste auf der rechten Seite des Fensters. Sie haben folgende Möglichkeiten:

    • Wählen Sie jede Eigenschaft aus, um ihre Definition unterhalb des Bereichs auf der rechten Seite anzuzeigen.
    • Im Abschnitt Snippet-Schlüsselwörter auf dieser Seite finden Sie Details zur Konfiguration der einzelnen Befehle.
  7. Fügen Sie nach Bedarf weitere Schlüsselwörter hinzu.
  8. Sie können jederzeit auf die Registerkarte Text View klicken, um den Code im traditionellen Codierungsformat anzuzeigen.
  9. Sie können Ihre Änderungen jederzeit speichern, ohne das Editor-Fenster zu schließen, indem Sie auf Apply klicken.
  10. Klicken Sie auf OK, wenn Sie die Bearbeitung des Codes abgeschlossen haben.

Debuggen von Snippet-Code

Die Snippet-Aktion verfügt über einen eigenen Debugger, mit dem Sie den Code überprüfen können. Sie können Code nur auf der Registerkarte "Textansicht" debuggen.

Wenn Sie Ihren Code auf der Registerkarte "Strukturansicht" erstellt haben, wechseln Sie zur Registerkarte "Textansicht", um den Code zu debuggen. Wenn der Debugger Fehler feststellt, können Sie den betroffenen Codebereich anhand der angegebenen Zeilennummer identifizieren. Dann können Sie zur Registerkarte "Strukturansicht" zurückkehren, um das Problem zu beheben.

Es stehen weitere Optionen zum Debuggen zur Verfügung. Beispielsweise können Sie den Code Zeile für Zeile untersuchen und Haltepunkte verwenden. Sie können auch TRACE-Anweisungen im Snippet-Code verwenden, um beim Debuggen Text auszugeben. Diese Ausgabe kann hilfreich sein, um Probleme im Skript zu beheben.

  1. Öffnen Sie in Studio ein Skript, das eine Snippet-Aktion enthält.
  2. Doppelklicken Sie auf die Snippet-Aktion.
  3. Fügen Sie Snippet-Code auf der Registerkarte Text View hinzu, falls noch nicht vorhanden.
  4. Klicken Sie rechts im Snippet editor-Fenster auf die Registerkarte Debugger.
  5. Klicken Sie rechts neben dem Symbol Debug auf den Abwärtspfeil und wählen Sie StartSymbol einer grünen, dreieckigen Abspielen-Schaltfläche. aus.

  6. Wenn Syntaxfehler im Code vorhanden sind, wird das Snippet editor-Fenster erweitert. Alle Fehler im Code werden in einem Bereich unten im Fenster angezeigt. Wenn keine Fehler vorliegen, fahren Sie mit dem nächsten Schritt fort.

    Das Snippet-Editor-Fenster mit dem Fehlerbereich unten im Fenster.
    1. Korrigieren Sie die Fehler.
    2. Nachdem Sie die Fehler behoben haben, klicken Sie auf das Symbol Close oder Clear Trace Output , um den Fehlerbereich zu schließen.
    3. Starten Sie den Debugger neu.
  7. Zeigen Sie den Inhalt der Registerkarte Variables as Text an. Auf der Registerkarte werden die Variablen und ihre Werte angezeigt, nachdem der ganze Code ausgeführt wurde, wenn Sie keinen Haltepunkt gesetzt haben.
  8. Sie können eine oder mehrere Zeilen im Snippet-Code auswählen und auf das Symbol Comment out selected lines klicken. Dies ist hilfreich, wenn Sie Code entfernen möchten, um festzustellen, wie sich das Ergebnis des Debugging-Vorgangs dadurch ändert.
  9. Sie können eine oder mehrere auskommentierte Codezeilen auswählen und auf das Symbol Uncomment the selected lines klicken, um dem Snippet diese Zeilen wieder hinzuzufügen.