Travailler avec l'éditeur de script
Utilisez l'éditeur de script fourni dans les pages Traitement pour écrire les instructions de traitement des objets exécutables. L'éditeur de script vous propose diverses fonctionnalités vous permettant d'écrire vos scripts, tels que la surbrillance de syntaxe, la réutilisation de codes, ainsi qu'une fonction de recherche et remplacement.
Remarques :
- Vous pouvez configurer des préférences basiques de l'éditeur de script dans les paramètres utilisateur et de session. Voir Définir les paramètres de l'éditeur de scripts.
- Interface Web Automic propose un certain nombre de touches de raccourci, afin de faciliter et d'accélérer votre travail avec l'éditeur de script. Voir Raccourcis clavier.
Cette rubrique contient les sujets suivants :
L'éditeur de script propose diverses fonctionnalités vous permettant d'écrire vos scripts.
Les éléments de script sont affichés en différentes couleurs selon leur catégorie pour vous aider à les reconnaître facilement :
- Vert
Commentaires
Exemple : !####-STOP-#### - Bleu
Instructions de script et variables prédéfinies
Exemple : :PRINT - Rouge
Fonctions de script
Exemple : ACTIVATE_UC_OBJECT - Marron
Lignes JCL (Job Control Language)
Exemple : echo FileContent > c:\temp\FileName.txt - Gris
Chaînes de caractères
Exemple : "GENERIC.09.JOBS" - Violet
Variables de script
Exemple : &RUNID# - Surbrillance jaune
Élément de script sélectionné
Exemple : MODIFY_TASK
Remarque : faites un clic droit sur un élément pour le sélectionner et ouvrir un menu contextuel contenant toutes les fonctions disponibles pour l'élément sélectionné. Cliquez, double-cliquez ou passez votre curseur sur un ou plusieurs éléments pour ouvrir une infobulle contenant les détails de la syntaxe, SANS que cela ne sélectionne les éléments.
Pour plus d'informations, voir Éléments de script et syntaxe.
L'éditeur de script affiche les infobulles avec les éléments de script et leur syntaxe pendant la saisie. Les infobulles suggèrent la bonne syntaxe pour l'instruction de script, la fonction et l'argument de la fonction. Les infobulles affichent également les arguments suivants pour les instructions (exemple : condition IF, ELSE). Les infobulles suivantes dépendent de vos actions :
- Cliquez ou double-cliquez sur un élément pour afficher sa syntaxe.
- Cliquez ou double-cliquez sur une instruction pour afficher les arguments possibles.
- Commencez à écrire une fonction de script ou pointez votre souris sur une fonction de script adjacente pour afficher la syntaxe de variable de script possible.
Si votre fonction de script a plusieurs possibilités de syntaxe, l'infobulle les affiche toutes.
Utilisez la fonction de saisie semi-automatique pour insérer les éléments de script pendant votre saisie. La fonction de saisie semi-automatique suggère les fonctions et les instructions Langage de script Automation Engine. La fonction de saisie semi-automatique suggère également les variables déjà utilisées, y compris les variables prédéfinies.
- Commencez à saisir l'élément.
- Appuyez sur Ctrl + espace.
- Un menu contextuel affiche une liste de toutes les fonctions correspondant à votre saisie. Double-cliquez sur celle dont vous avez besoin.
Aide contextuelle pour le script
Faites un clic droit sur un mot-clé Automation Engine dans l'éditeur de script, puis sélectionnez Rechercher dans l'aide, dans le menu contextuel. L'aide en ligne s'ouvre et la recherche d'aide démarre automatiquement avec l'élément sélectionné inséré dans le champ Recherche.
Barre d'outils de l'éditeur de script
Lorsque vous écrivez des scripts, utilisez les boutons de la barre d'outils de l'éditeur de script pour les actions suivantes :
- Annuler
Annule votre dernière modification. Vous pouvez également appuyer sur Ctrl+Z. - Rétablir
Rétablit la dernière action annulée. Vous pouvez également appuyer sur Ctrl+Y. - Commentaire
Ajoute un point d'exclamation au début de la ou des lignes sélectionnées. Vous pouvez également saisir le point d'exclamation, mais ce bouton est utile pour marquer plusieurs lignes en tant que commentaires. Les lignes commentées sont ignorées pendant l'exécution. - Supprimer le commentaire
Supprime le point d'exclamation. Les lignes n'étant plus commentées, elles sont traitées pendant l'exécution. Si une ligne contient plusieurs points d'exclamation et que l'un d'eux se trouve en début de ligne, seul le premier point d'exclamation est supprimé. - Décaler et Aligner
Diminue ou augmente le retrait des lignes sélectionnées. Les deux points identifiant les lignes d'instruction de script et les points d'exclamation identifiant les lignes de commentaires restent en début de ligne, tandis que le reste de la ligne est décalé vers la droite ou vers la gauche. - Import et Export
Importer ou exporter tout un script. Positionnez le curseur à l'endroit où vous souhaitez importer les lignes de script. La fonction d'exportation génère un fichier texte contenant le script à télécharger. Pour plus d'informations, voir Réutiliser des composants de script. - Tout reformater
Applique un formatage cohérent à tout le script : met en retrait les blocs imbriqués, supprime les espaces de retrait inutiles et ajoute un espace après un caractère de commentaire (!).
Exemple : après reformatage, la ligne : ..........PRINT"Start of processing" se présente ainsi ::PRINT"Start of processing"
Rechercher et remplacer des chaînes de caractères
Vous pouvez rechercher et remplacer les chaînes de caractères d'un script si l'objet a été ouvert en mode édition. Lorsque l'objet n'est pas ouvert en mode édition, la fonction de recherche est désactivée. La fonction de recherche ne recherche que dans le script actuellement ouvert dans l'éditeur de script.
Pour rechercher ou remplacer une chaîne de caractères dans le script
- Cliquez sur Rechercher dans la barre d'outils de l'éditeur de script ou appuyez sur Ctrl+F pour ouvrir la recherche. Pour remplir automatiquement le champ de recherche avec une chaîne de caractères, sélectionnez-la dans l'éditeur avant d'ouvrir la recherche.
- Saisissez la chaîne ou les chaînes dans les champs :
- Rechercher
Saisissez la chaîne recherchée. La liste déroulante rappelle les 30 dernières chaînes recherchées. - Remplacer par
Saisissez une nouvelle chaîne pour remplacer votre chaîne de recherche. La liste déroulante rappelle les 30 dernières chaînes recherchées.
- Rechercher
- Spécifiez les options de recherche :
- Direction
Recherchez sur ou sous l'emplacement actuel, ou recherchez de toutes les occurrences de la chaîne. - Respecter la casse
Sélectionnez cette option pour effectuer une recherche respectant la casse. - Mot entier
Sélectionnez cette option pour rechercher des chaînes séparées du reste du texte par les caractères suivants :- Vides ( )
- Onglets (\t)
- Nouvelles lignes (\r\n ou \n)
- Marques de ponctuation (, . ; : ? !)
- Caractères spéciaux (\ ^ $ | ( ) [ ] { } EOF)
- Direction
- Procédez selon l'une des méthodes suivantes :
- Appuyez sur [Entrée] ou cliquez sur Trouver suivant pour mettre en surbrillance la première occurrence de la chaîne de caractères.
- Cliquez sur Rechercher tout pour mettre en surbrillance toutes les occurrences.
- Pour remplacer une occurrence spécifique, cliquez Trouver suivant jusqu'à ce que la correspondance souhaitée soit en surbrillance puis cliquez Remplacer/Rechercher.
- Pour remplacer toutes les occurrences, cliquez sur Remplacer tout.
Le nombre d'occurrences ou de remplacements s'affiche en bas de la barre de recherche.
Convertir en majuscules ou minuscules
Sélectionnez un ou plusieurs mots, faites un clic droit, puis sélectionnez Majuscule ou Minuscule dans le menu contextuel. Les caractères spéciaux et les nombres ne sont pas affectés par la conversion de casse.
Conversion automatique en majuscules pour les jobs OS/390 et AS/400
L'éditeur de script reconnaît les scripts de jobs OS/390 ou AS/400 et convertit automatiquement ces lignes de script en MAJUSCULES. Les nombres, les caractères non alphabétiques, les scripts importés et les textes copiés-collés ne sont pas affectés. Si vous avez besoin d'écrire ces scripts en minuscules, appuyez sur Maj, puis saisissez votre texte.
Exemple
Si vous saisissez wait100, l'éditeur de script convertit automatiquement le texte en WAIT100.
Manipuler des objets dans l'éditeur de script
L'éditeur de script traite toutes les chaînes correspondant aux critères suivants comme un nom d'objet potentiel :
- Contient des caractères alphanumériques sans accents
-
Peut contenir les caractères spéciaux suivants :
. _ # @ - $
- Commence ou se termine par l'un des caractères suivants :
- Espaces, tabulations, nouvelles lignes
- Trémas ou tous autres caractères spéciaux
- Des marques de ponctuation autres que des points
Ouvrir et modifier un objet à partir de l'éditeur de script
Lorsque vous écrivez des scripts, vous faites souvent référence aux objets disponibles dans votre système. Vous pouvez modifier les paramètres d'un objet auquel vous faites référence directement dans l'éditeur de script. Passez votre curseur sur le nom de l'objet, faites un clic droit, puis sélectionnez Ouvrir dans le menu contextuel. Cela ouvre les pages de définition de l'objet vous permettant d'éditer les paramètres si vous avez la permission d'écriture.
Ouvrir la liste des exécutions d'un objet
Vous pouvez ouvrir les listes des données d'exécution d'un objet inclus dans un script, directement à partir de l'éditeur de script. Faites un clic droit sur le nom de l'objet, puis sélectionnez Exécutions dans le menu contextuel. Pour plus d'informations sur les listes d'exécution, voir Données d'exécution.
Ouvrir le dernier rapport d'un objet
Vous pouvez vérifier les détails du dernier rapport de l'objet, sans quitter l'éditeur de script. Faites un clic droit sur le nom de l'objet, puis sélectionnez Ouvrir dernier rapport dans le menu contextuel. Pour plus d'informations sur les rapports d'objets, voir Rapports.
Utiliser des objets Include dans les scripts
Les objets Include (JOBI) vous permettent d'enregistrer et de réutiliser des blocs de scripts usuels. Écrivez une instruction :INCLUDE dans la ligne où vous souhaitez appeler l'objet Include. Les lignes de script incluses sont alors insérées à cet endroit.
- Pour voir les lignes de script insérées d'un objet Include (lecture seule), cliquez sur l'icône + dans la ligne de l'instruction :INCLUDE. Une boîte de dialogue d'éditeur de script affichant les lignes insérées s'ouvre. Les lignes s'affichent en lecture seule.
- Pour éditer les lignes de script, faites un clic droit sur le nom de l'objet Include, sélectionnez Ouvrir dans le menu contextuel, puis modifiez le script directement dans l'objet Include lui-même.
Remarques :
- Afin de pouvoir éditer les lignes de script insérées, vous avez besoin de permissions en écriture sur l'objet Include. Si vous n'avez que les permissions en lecture sur l'objet Include, vous pouvez voir les lignes de script insérées. Si vous n'avez pas de permissions en lecture, ni en écriture sur l'objet Include, vous ne pouvez ni développer, ni modifier les lignes insérées.
- La recherche de l'éditeur de script n'inclut le contenu des objets Include que si les lignes de script sont développées.
- Si vous exportez le script vers un fichier texte ou copiez les lignes de script insérées via un objet Include, seul le contenu étendu est pris en compte.
Conseil : Si vous voyez des objets Include complexes ou imbriqués dans votre script, vous pouvez détacher les boîtes de dialogue de l'éditeur de script dans lesquelles les lignes insérées s'affichent. Cliquez sur l'icône de détachement , en haut, à droite de la boîte de dialogue de l'éditeur de script pour détacher la boîte de dialogue dans une fenêtre distincte.
Pour plus d'informations :
Importer et exporter des blocs de code
Vous pouvez importer et exporter des blocs de code dans l'éditeur de script. L'exportation de code vous permet de réutiliser les scripts facilement et rapidement dans diverses installations. Cette fonction est disponible sur toutes les pages Traitement ainsi que dans l'objet Script.
Vous pouvez importer le contenu d'un fichier disponible sur votre ordinateur, vers votre script. Vous pouvez également exporter le script en entier à un fichier que vous pouvez ensuite importer sur un système différent.
Remarques :
- L'exportation d'un script s'applique toujours au script entier. Vous ne pouvez pas exporter uniquement le texte actuellement sélectionné. Pour n'exporter qu'une partie de votre script, il vous suffit de copier et coller le texte souhaité.
- La fonction d'importation et d'exportation ne s'applique qu'au contenu de l'éditeur de script actuellement affiché. Pour importer ou exporter des objets entiers, utilisez à la place la fonction Importer / Exporter de la perspective Conception des processus. Voir Importer / exporter des objets.
Pour importer du code depuis un fichier
- Placez votre curseur dans la position où vous souhaitez insérer le code importé.
- Faites un clic droit, puis sélectionnez Importer dans le menu contextuel.
- Cliquez sur l'icône de téléchargement, dans la boîte de dialogue Importer.
- Localisez le fichier dans votre système de fichiers local, puis cliquez sur Ouvrir.
- Le fichier sélectionné est téléchargé et son contenu est inséré à la position actuelle du curseur.
La taille de fichier maximale pour les téléchargements est définie par la clé MAX_IMPORT_SIZE (voir UC_CLIENT_SETTINGS - Divers paramètres du client). La limite matérielle est de 30720 Ko maximum. Nous ne recommandons pas d'importer des scripts de plus de 500 ko, car cela risque d'impacter les performances de l'éditeur de script.
Pour exporter du code vers un fichier
- Ouvrez le script.
- Cliquez sur le bouton Exporter, dans la barre d'outils de l'éditeur de script.
- Le script entier est téléchargé dans un fichier texte ayant le nom de l'objet suivi par "_sheet.script". Le chemin de téléchargement dépend des paramètres de votre navigateur.
Voir aussi :
voiraussi