Aangepaste codesnippets

Sommige scripts vereisen meer complexiteit dan de kant-en-klare Studio-acties alleen kunnen bieden. In Studio kunt u aangepaste code toevoegen aan uw scripts. Hiermee kunt u uw scripts aanpassen aan de behoeften van uw organisatie.

Aangepaste codering vereist wat kennis van scripts of programmering. Studio maakt gebruik van een aangepaste programmeertaal genaamd Snippet, die is ontwikkeld voor gebruik in Studio. Een volledige technische referentiehandleiding is beschikbaar in de online help zodat u kunt leren om deze taal te gebruiken.

Belangrijke informatie over snippets

  • Code-snippets kunnen de organisatie en efficiëntie van uw scripts helpen verbeteren. Ze vermeerderen uw controle over de processen die ze uitvoeren, evenals wanneer en hoe ze worden uitgevoerd. U kunt uw eigen variabelen en objecten maken en programmeerlogica toevoegen met verklaringen, zoals IF, FOR, FOREACH en andere.
  • Sommige producten en functies vereisen fragmenten, maar u kunt ze gebruiken in uw scripts, zelfs als ze niet vereist zijn.
  • Wanneer een product of functie code-snippets vereist, biedt de online help gedetailleerde informatie over de snippets die u moet opnemen. Voorbeelden van scripts worden geleverd om te tonen hoe u de code-snippets in scripts kunt gebruiken. Er kunnen extra scripts nodig zijn om de producten of functies te implementeren.
  • De Snippet-scripttaal wordt gebouwd op het .NET-framework. Dit wordt aan de serverzijde uitgevoerd en wordt gecompileerd naar MSIL (Microsoft Intermediate Language), net zoals C# en Visual Basic .NET.

Snippet-actie

Om een aangepaste code toe te voegen aan uw scripts, hebt u een Snippet actie nodig. U kunt dubbelklikken op deze actie om een editorvenster te openen waar u uw aangepaste code kunt toevoegen. U kunt de code ook debuggen in het editorvenster. U hebt meer dan één Snippet-actie nodig in uw script. Als u meerdere acties gebruikt, werkt u het veld Caption van elke actie bij met een woordgroep die u helpt bij het identificeren van zijn doel.

De locatie waar een Snippet actie wordt geplaatst, is van belang. Als een Snippet een waarde toewijst aan een variabele, moet deze worden geplaatst voor de actie die de waarde vereist. Als een Snippet anderszins een besluitvormingscode bevat die werkt op basis van een waarde die eraan wordt doorgegeven, moet de Snippet na de actie die de waarde levert, worden geplaatst.

Snippets vergeleken met acties

Een deel van wat u kunt doen in snippets, kan ook gebeuren met de Studio-acties. Er zijn bijvoorbeeld acties voor de verklaringen IF en FOR. Er is ook de ASSIGN-actie die u kunt gebruiken om een aangepaste variabele te maken en er een waarde aan toe te wijzen. Het gebruik van deze acties is een acceptabele manier om deze capaciteiten toe te voegen aan uw script. Het gebruik van snippets is echter efficiënter.

Door de code in snippets te plaatsen, wordt uw script schoner, meer georganiseerd en gemakkelijker te navigeren. Dit maakt uw job als een scriptschrijver gemakkelijker en efficiënter. Als u er een gewoonte van maakt om altijd variabelen te declareren in snippets, en u in de toekomst een specifieke declaratie moet zoeken, hebt u minder plaatsen waar u moet zoeken.

Een aangepaste code toevoegen aan een script

Met de Snippet actie kunt u een aangepaste code toevoegen aan uw scripts. Deze actie bevindt zich in de sectie Geavanceerd van het standaardpalet op het tabblad Tools.

  1. Open uw script in Studio.
  2. Plaats een Snippet-actie in uw script waar u de code nodig hebt en koppel de actie aan de andere acties.
  3. Dubbelklik op de actie om het editorvenster te openen. Hier kunt u uw code toevoegen.

  4. Klik op het tabblad dat u wilt gebruiken voor het toevoegen van uw code. Elk tabblad biedt een andere methode voor het toevoegen van code. De tabbladen zijn:

  5. Debuggen uw code als u dat wilt.

  6. U kunt op Apply klikken om de wijzigingen op te slaan zonder het editorvenster te sluiten.
  7. Klik op OK als u klaar bent met het bewerken van de code.

Code met tekstweergave

Via het tabblad Tekstweergave in het Fragmentvenster kunt u uw Snippet code met de hand schrijven. Een volledige naslaggids is beschikbaar in de online Help, zodat u kunt leren om deze taal te gebruiken.

  1. Open uw script in Studio.
  2. Voeg de actie Snippet toe aan uw script en dubbelklik erop om het Fragment-venster te openen.
  3. Voer uw code in aan de linkerzijde van het tabblad Boomstructuur. U kunt de code typen, of u kunt code kopiëren en plakken vanuit een andere bron zoals deze online Help of een ander script.
  4. Klik op enig moment op het Tree View-tabblad om code toe te voegen via de vooraf gedefinieerde trefwoorden. U kunt de pijlen omhoog en omlaag gebruiken om code die verwant is met een trefwoord te verplaatsen naar een ander punt in het script.
  5. Klik op het Check Syntax pictogram Het pictogram Syntax controleren: drie groene cirkeltjes met een driehoek die naar rechts wijst. om te controleren of de syntaxis van de huidige code klopt. Het statusveld in de werkbalk onder aan het tabblad Tekstweergave geeft de status Okay als er geen fouten zijn. Als er fouten zijn, verschijnt een pop-upbericht over de fout en wordt er een bericht weergegeven in het statusveld in de werkbalk. Het bericht is bijvoorbeeld Error at line 4.
  6. Klik op het Comment pictogram Het pictogram Commentaar: een schuine streep tussen punthaakjes. als u de regel waar de cursor zich momenteel bevindt wilt omzetten in een commentaarregel.
  7. Klik op het Uncomment pictogram Het pictogram Commentaar opheffen: een schuine streep tussen punthaakjes met een grote rode streep erdoorheen. om de commentaartekens te verwijderen van de regel waar de cursor zich momenteel bevindt.
  8. U kunt op Apply klikken om de wijzigingen op te slaan zonder het editorvenster te sluiten.
  9. Klik op OK als u klaar bent met het bewerken van de code.

Code toevoegen in de Boomstructuur

Het tabblad Boomstructuur in het venster Snippet-eigenschappen begeleidt u bij het maken van aangepaste code. Er is een vooraf gedefinieerde set trefwoorden beschikbaar waaruit u kunt kiezen.

  1. Open uw script in Studio.
  2. Voeg de Snippet-actie toe aan uw script en dubbelklik erop om het Snippet-venster te openen.
  3. Klik onder in het tabblad Boomstructuur op het plusteken Een plus-teken met daarnaast een pijl die omlaag wijst..

  4. Het venster Snippet-eigenschappen met het tabblad Boomstructuur. Het groene plusteken is ingedrukt en het menu met Snippet-instructies is zichtbaar.

    Selecteer het trefwoord dat u aan uw code wilt toevoegen.
  5. Klik op het trefwoord dat verschijnt in de lijst aan de linkerzijde van het venster om de eigenschappen te bekijken.

  6. Configureer de eigenschappen van het trefwoord in de lijst aan de rechterzijde van het venster. Je kunt het volgende doen:

    • Selecteer een eigenschap om een definitie van de eigenschap weer te geven in het vak onder het rechterpaneel.
    • Zie het gedeelte Snippet-trefwoorden op deze pagina voor meer informatie over het configureren van elke instructie.
  7. Voeg eventueel nog meer trefwoorden toe.
  8. Klik op elk willekeurig tijdstip op het Text View-tabblad om de code weer te geven die is uitgeschreven in traditioneel codeerformaat.
  9. U kunt op Apply klikken om de wijzigingen op te slaan zonder het editorvenster te sluiten.
  10. Klik op OK als u klaar bent met het bewerken van de code.

Snippetcode debuggen

De Snippet-actie heeft zijn eigen debugger die u kunt gebruiken om de code te controleren. U kunt code alleen debuggen vanaf het tabblad Tekstweergave.

Als u uw code hebt gemaakt op het tabblad Boomstructuur, kunt u de debugger gebruiken als u schakelt naar het tabblad Tekstweergave. Als de debugger problemen aantreft, gebruikt u het opgegeven lijnnummer om te bepalen welk deel van de code het probleem bevat. U kunt dan terugkeren naar het tabblad Boomstructuur om het probleem te corrigeren.

Er zijn meer debuggingsopties beschikbaar, inclusief lijn voor lijn door de code gaan en onderbrekingspunten gebruiken. U kunt ook TRACE statements in snippetcode gebruiken om tekst uit te voeren tijdens debugging. Deze uitvoer kan handig zijn voor het oplossen van problemen in uw script.

  1. Open een script in Studio die een Snippet-actie bevat.
  2. Dubbelklik op de Snippet-actie.
  3. Voeg een Snippet-code toe op het tabblad Text View , als het nog geen code bevat.
  4. Klik aan de rechterzijde van het venster Snippet editor op het tabblad Debugger.
  5. Klik op de pijl omlaag rechts van het Debug pictogram en selecteer StartEen pictogram van een groene driehoek met afspeelknop..

  6. Als er syntaxisfouten in de code zijn, wordt het venster Snippet editor uitgevouwen. Alle fouten in de code verschijnen in een paneel onderaan in het venster. Als er geen fouten zijn, gaat u verder naar de volgende stap.

    Het venster Fragment-editor met de foutpanelen onderaan in het venster.
    1. Corrigeer de fouten.
    2. Wanneer de fouten zijn gecorrigeerd, klikt u op het pictogram Close of Clear Trace Output om het foutpaneel te sluiten.
    3. Start de debugger opnieuw.
  7. Geef de inhoud van het tabblad Variables as Text weer. Het tabblad toont de variabelen en hun waarden wanneer de volledige code is uitgevoerd als u geen onderbrekingspunt hebt ingesteld.
  8. U kunt een of meer regels in de fragmentcode selecteren en op het Comment out selected lines pictogram klikken. Dit is handig als u wat code wilt verwijderen om te zien hoe het resultaat van de debugging verandert.
  9. U kunt een of meer regels van als commentaar gemarkeerde code selecteren en op het Uncomment the selected lines pictogram klikken om die lijnen terug toe te voegen in het fragment.