Extraits de code personnalisés

Certains scripts nécessitent plus de complexité que les actions Studio ne peuvent en fournir à elles seules. Studio vous permet d’ajouter du code personnalisé à vos scripts. Cela vous permet de personnaliser vos scripts en fonction des besoins de votre organisation.

Le codage personnalisé nécessite des connaissances en matière de script ou de programmation. Studio utilise un langage de programmation personnalisé appelé Snippet, développé pour être utilisé dans Studio. Un guide de référence technique complet est disponible dans l’aide en ligne pour vous permettre d’apprendre à utiliser ce langage.

Faits saillants concernant les extraits de code

  • Les extraits de code peuvent contribuer à améliorer l’organisation et l’efficacité de vos scripts. Ils vous permettent de mieux contrôler les processus exécutés, ainsi que le moment et la manière dont ils s’exécutent. Vous pouvez créer vos propres variables et objets et ajouter une logique de programmation à l’aide d’instructions telles que IF, FOR, FOREACH, etc.
  • Certains produits et fonctionnalités requièrent des extraits de code, mais vous pouvez les utiliser dans vos scripts même s’ils ne sont pas nécessaires.
  • Lorsqu’un produit ou une fonctionnalité nécessite des extraits de code, l’aide en ligne fournit des informations détaillées sur les extraits de code que vous devez inclure. Des exemples de scripts sont fournis pour montrer comment utiliser les extraits de code dans les scripts. Des scripts supplémentaires peuvent être nécessaires pour mettre en œuvre les produits ou les fonctionnalités.
  • Le langage de script Snippet est basé sur le cadre .NET. Il s’exécute côté serveur et se compile en MSIL (Microsoft Intermediate Language) comme le font C# et Visual Basic .NET.

Action d’extrait de code

Pour ajouter du code personnalisé à vos scripts, vous avez besoin d’une action Snippet. Vous pouvez double-cliquer sur cette action pour ouvrir un éditeur dans lequel vous pouvez ajouter votre code personnalisé. Vous pouvez également déboguer le code dans la fenêtre de l’éditeur. Il se peut que vous ayez besoin de plus d’une action Snippet dans votre script. Si vous utilisez plusieurs actions, mettez à jour le champ Caption de chacune d’entre elles avec une phrase qui aide à identifier son objectif.

L’emplacement d’une action Snippet est important. Si une Snippet attribue une valeur à une variable, elle doit être placée avant l’action qui a besoin de cette valeur. En revanche, si une Snippet contient un code décisionnel qui agit en fonction d’une valeur qui lui est transmise, l’Snippet doit être placée après l’action qui fournit la valeur.

Extraits de code par rapport aux actions

Certaines des actions que vous pouvez effectuer dans les extraits de code peuvent également être réalisées à l’aide des actions Studio. Par exemple, il existe des actions pour les instructions IF et FOR. Il existe également l’action ASSIGN, que vous pouvez utiliser pour créer une variable personnalisée et lui attribuer une valeur. L’utilisation de ces actions est un moyen acceptable d’ajouter ces capacités à votre script. Cependant, l’utilisation d’extraits de code est plus efficace.

En plaçant le code dans des extraits de code, votre script est plus propre, mieux organisé et plus facile à parcourir. Cela rend votre travail de scripteur plus facile et plus efficace. Si vous prenez l’habitude de toujours déclarer les variables dans les extraits de code, à l’avenir, si vous avez besoin de retrouver une déclaration particulière, vous aurez moins d’endroits où chercher.

Ajouter un code personnalisé à un script

L’action Snippet vous permet d’ajouter du code personnalisé à vos scripts. Cette action se trouve dans la section Avancé de la palette par défaut de l’onglet Outils.

  1. Dans Studio, ouvrez votre script.
  2. Placez une action Snippet dans votre script à l’endroit où vous avez besoin du code et reliez-la aux autres actions.
  3. Double-cliquez sur l’action pour ouvrir la fenêtre de l’éditeur. C’est ici que vous pouvez ajouter votre code.

  4. Cliquez sur l’onglet que vous souhaitez utiliser pour ajouter votre code. Chaque onglet propose une méthode différente pour ajouter du code. Les onglets sont les suivants :

  5. Déboguez votre code, au besoin.

  6. Cliquez en tout temps sur Apply pour enregistrer vos modifications sans fermer la fenêtre de l’éditeur.
  7. Cliquez sur OK lorsque vous avez fini de modifier le code.

Code avec vue texte

L'onglet Vue texte de la fenêtre Extrait vous permet d'écrire votre code à la main.Snippet Un guide de référence complet est disponible dans l’aide en ligne pour vous permettre d’apprendre à utiliser ce langage.

  1. Dans Studio, ouvrez votre script.
  2. Ajoutez l'action Snippet à votre script et double-cliquez dessus pour ouvrir la fenêtre Snippet.
  3. Dans la partie gauche de l’onglet Arborescence, saisissez votre code. Vous pouvez taper le code ou le copier-coller à partir d’une autre source, comme ce site d’aide ou un autre script.
  4. Cliquez à tout moment sur l’onglet Tree View pour ajouter du code à partir des mots-clés prédéfinis. Vous pouvez utiliser les boutons fléchés vers le haut et vers le bas pour déplacer le code lié à un mot-clé à un autre endroit du script.
  5. Cliquez sur l’icône Check Syntax L’icône Vérifier la syntaxe, trois petits cercles verts avec un triangle pointant vers la droite. pour vérifier que la syntaxe du code actuel est correcte. Le champ d’état dans la barre d’outils au bas de l’onglet Vue textuelle affiche l’état Okay s’il n’y a pas d’erreurs. En cas d’erreur, un message d’erreur apparaît et le champ d’état de la barre d’outils affiche un message. Par exemple, le message peut être : Error at line 4.
  6. Cliquez sur l’icône Comment L’icône Commentaire, une équerre ouverte et une équerre fermée séparées par une barre oblique bleue. pour convertir la ligne où se trouve le curseur dans un commentaire.
  7. Cliquez sur l’icône Uncomment L’icône Annuler le commentaire, une grande barre oblique rouge superposée à une équerre ouverte et à une équerre fermée séparées par une barre oblique. pour supprimer les caractères de commentaire de la ligne où se trouve le curseur.
  8. Cliquez en tout temps sur Apply pour enregistrer vos modifications sans fermer la fenêtre de l’éditeur.
  9. Cliquez sur OK lorsque vous avez fini de modifier le code.

Code avec Arborescence

L’onglet Arborescence de la fenêtre Propriétés de l’extrait de code vous guide tout au long du processus de création de code personnalisé. Un ensemble prédéfini de mots-clés est à votre disposition.

  1. Dans Studio, ouvrez votre script.
  2. Ajoutez l’action Snippet à votre script et double-cliquez dessus pour ouvrir la fenêtre Extrait de code.
  3. Cliquez sur l’icône plus Un signe plus avec une flèche pointant vers le bas. en bas de l’onglet Arborescence.

  4. La fenêtre des propriétés de l’extrait de code, avec l’onglet Arborescence. L’icône verte du signe plus est activée et le menu des commandes d’extrait de code s’affiche.

    Sélectionnez le mot-clé que vous souhaitez ajouter à votre code.
  5. Cliquez sur le mot-clé qui apparaît dans la liste à gauche de la fenêtre pour afficher ses propriétés.

  6. Configurez les propriétés du mot-clé dans la liste située à droite de la fenêtre. Vous pouvez :

    • Sélectionnez chaque propriété pour en afficher la définition dans l’espace situé sous le volet de droite.
    • Reportez-vous à la section Mots-clés d’extrait de code de cette page pour plus de détails sur la configuration de chaque commande.
  7. Ajoutez d’autres mots-clés si nécessaire.
  8. Cliquez à tout moment sur l’onglet Text View pour visualiser le code écrit dans un format de codage traditionnel.
  9. Cliquez en tout temps sur Apply pour enregistrer vos modifications sans fermer la fenêtre de l’éditeur.
  10. Cliquez sur OK lorsque vous avez fini de modifier le code.

Déboguer l’extrait de code

L’action Snippet possède son propre débogueur que vous pouvez utiliser pour vérifier le code. Vous ne pouvez déboguer le code qu’à partir de l’onglet Vue textuelle.

Si vous avez créé votre code dans l’onglet Arborescence, vous pouvez utiliser le débogueur si vous passez à l’onglet Vue textuelle. Si le débogueur trouve des problèmes, utilisez le numéro de ligne spécifié pour déterminer quelle partie du code contient le problème. Vous pouvez ensuite revenir à l’onglet Arborescence pour corriger le problème.

D’autres options de débogage sont disponibles, notamment pour parcourir le code ligne par ligne et pour utiliser des points d’arrêt. Vous pouvez également utiliser les instructions TRACE dans le code de l’extrait pour produire du texte pendant le débogage. Cette sortie peut être utile pour résoudre des problèmes dans votre script.

  1. Dans Studio, ouvrez un script contenant une action Snippet.
  2. Double-cliquez sur l’action Snippet.
  3. Ajoutez le code Snippet dans l’onglet Text View , s’il ne contient pas déjà.
  4. Dans la partie droite de la fenêtre Snippet editor, cliquez sur l’onglet Debugger.
  5. Cliquez sur la flèche descendante à droite de l’icône Debug et sélectionnez StartUne icône représentant un bouton de lecture vert en forme de triangle..

  6. Si le code contient des erreurs de syntaxe, la fenêtre Snippet editor s’agrandit. Toutes les erreurs dans le code apparaissent dans un volet au bas de la fenêtre. S’il n’y a pas d’erreur, passez à l’étape suivante.

    La fenêtre de l’éditeur d’extraits de code, montrant le volet des erreurs en bas de la fenêtre.
    1. Corrigez les erreurs.
    2. Lorsque les erreurs ont été corrigées, cliquez sur les icônes Close ou Clear Trace Output pour fermer le volet d’erreurs.
    3. Redémarrez le débogueur.
  7. Consultez le contenu de l’onglet Variables as Text . L’onglet montre les variables et leurs valeurs lorsque tout le code a été exécuté si vous n’avez pas placé de point d’arrêt.
  8. Vous pouvez sélectionner une ou plusieurs lignes dans le code de l’extrait et cliquer sur l’icône Comment out selected lines . C’est utile si vous voulez supprimer du code pour voir comment le résultat du débogage change.
  9. Vous pouvez sélectionner une ou plusieurs lignes de code commentées et cliquer sur l’icône Uncomment the selected lines pour ajouter ces lignes dans l’extrait de code.