Snippets de code personnalisé

Certains scripts nécessitent plus de complexité que les actions Studio ne peuvent en fournir à elles seules. Studio permet d'ajouter du code personnalisé à vos scripts. Vous pouvez ainsi personnaliser vos scripts afin de répondre aux 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 afin de vous permettre d'apprendre à utiliser ce langage.

Faits clés à propos des Snippets

• Les snippets de code peuvent contribuer à améliorer l'organisation et l'efficacité de vos scripts. Ils vous permettent de mieux contrôler les processus qui s'exécutent, 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 et bien d'autres.
• Certains produits et fonctionnalités requièrent des snippets, 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 snippets de code, l'aide en ligne fournit des informations détaillées sur les snippets que vous devez inclure. Des exemples de scripts sont fournis pour montrer comment utiliser les snippets 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. Ce langage s'exécute côté serveur et se compile en MSIL (Microsoft Intermediate Language), tout comme 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 une fenêtre d'édition dans laquelle 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 plusieurs actions Snippet dans votre script. Si vous utilisez plusieurs actions, mettez à jour le champ Caption de chacune d’entre elles avec une phrase permettant d’identifier sa fonctionnalité.

L'emplacement d’une action Snippetest important. Si un Snippet attribue une valeur à une variable, il doit être placé avant l'action qui a besoin de cette valeur. D’autre part, si un Snippet contient un code décisionnel qui agit en fonction d'une valeur qui lui est transmise, le Snippet doit être placé après l'action qui fournit la valeur.

Comparaison des snippets et des actions

Certaines choses que vous pouvez effectuer dans les snippets peuvent également être réalisées à l'aide d’actions Studio. Par exemple, il existe des actions pour les déclarations IF et FOR. Il existe également une 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. Toutefois, l'utilisation de snippets est plus efficace.

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

Ajout de code personnalisé à un script

L'action Snippet 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 afin d'ouvrir la fenêtre de l’éditeur. Vous pouvez y ajouter votre code.

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

   • Vue arborescente : permet de créer du code personnalisé en utilisant des commandes d'une liste fournie dans l'application. Vous pouvez sélectionner la commande et fournir les détails nécessaires pour la configurer.

     Image de l'onglet Vue arborescente dans la fenêtre de l'Éditeur de snippets

     

   • Vue texte : permet d'entrer du code personnalisé manuellement. Cette option exige des aptitudes de base en rédaction de scripts.

     Image de l'onglet Vue texte dans la fenêtre de l'Éditeur de snippets

     

5. Vous pouvez éventuellement déboguer votre code.

6. Vous pouvez cliquer sur Apply à tout moment pour enregistrer vos modifications sans fermer la fenêtre de l'éditeur.
7. Cliquez sur OK lorsque vous avez terminé la modification du code.

Code avec vue texte

L’onglet Vue texte de la fenêtre Snippet vous permet d’écrire votre Snippet code à la main. Un guide de référence complet est disponible dans l'aide en ligne afin de 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 Vue arborescente, 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. Vous pouvez cliquer à 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 endroit différent du script.
5. Cliquez sur l'icône Check Syntax 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 de texte affiche l'état Okay s'il n'y a pas d'erreurs. En cas d'erreur, un message s’affiche dans une fenêtre contextuelle et le champ d'état de la barre d'outils affiche un message. Par exemple, le message pourrait être Error at line 4.
6. Cliquez sur l'icône Comment pour convertir la ligne où se trouve le curseur en commentaire.
7. Cliquez sur l'icône Uncomment pour supprimer les caractères de commentaire de la ligne où se trouve le curseur.
8. Vous pouvez cliquer sur Apply à tout moment pour enregistrer vos modifications sans fermer la fenêtre de l'éditeur.
9. Cliquez sur OK lorsque vous avez terminé la modification du code.

Code avec Vue arborescente

L'onglet Vue arborescente de la fenêtre Propriétés du snippet vous guide tout au long du processus de création de code personnalisé. Vous pouvez choisir parmi un ensemble prédéfini de mots-clés.

1. Dans Studio, ouvrez votre script.
2. Ajoutez l'action Snippet à votre script et double-cliquez dessus pour ouvrir la fenêtre Snippet.
3. Cliquez sur l'icône en bas de l’onglet Vue arborescente.
4. Voir l'image

   

   Sélectionnez le mot-clé que vous voulez ajouter à votre code.
5. Cliquez sur le mot-clé qui apparaît dans la liste sur la 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 sur la droite de la fenêtre. Vous pouvez :

   • Sélectionner 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 de snippet de cette page pour plus de détails sur la configuration de chaque commande.
7. Ajouter d'autres mots-clés si nécessaire.
8. Vous pouvez cliquer à tout moment sur l'onglet Text View pour visualiser le code écrit dans un format de codage traditionnel.
9. Vous pouvez cliquer sur Apply à tout moment pour enregistrer vos modifications sans fermer la fenêtre de l'éditeur.
10. Cliquez sur OK lorsque vous avez terminé la modification du code.

Débogage du code Snippet

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 texte.

Si vous avez créé votre code dans l'onglet Vue arborescente, vous pouvez utiliser le débogueur si vous passez à l'onglet Vue texte. 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 Vue arborescente pour corriger le problème.

D'autres options de débogage sont disponibles, notamment le défilement dans le code ligne par ligne et l’utilisation de points d'arrêt. Vous pouvez également utiliser des déclarations TRACEdans le code snippet 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 n'en 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 vers le bas à droite de l'icône Debug et sélectionnez Start.

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. Si aucune erreur n’a été rencontrée, passez à l’étape suivante.

   Voir l’image

   
   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. Affichez 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 défini de point d'arrêt.
8. Vous pouvez sélectionner une ou plusieurs lignes dans le code snippet et cliquer sur l'icône Comment out selected lines . Cela peut être utile si vous voulez supprimer du code afin de 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 le snippet.