Bonnes pratiques en matière de développement d'analyses
Les scripts d'outil d'analyse prennent en charge la plupart des commandes que vous pouvez utiliser dans un script ordinaire. Toutefois, vous devez vous assurer que les scripts d'analyse de données s'exécutent sans interaction avec l'utilisateur et qu'ils n'incluent pas de commandes non prises en charge par le moteur traitant les scripts d'analyse de données dans l'application Robots de Diligent One.
Les scripts d'outil d'analyse prennent en charge toutes les fonctions ACLScript.
Bonnes pratiques générales
Utiliser un projet Analytics par robot
Créez un nouveau projet Analytics pour chaque robot. Le projet doit contenir tous les scripts d'outil d'analyse constituant le robot et tous les sous-scripts requis.
Test en local
Testez tous les scripts d'outil d'analyse en local avant de les déployer dans l'application Robots. Assurez-vous que les scripts d'outil d'analyse s'exécutent comme prévu et qu'ils ne nécessitent pas d'interaction de l'utilisateur.
Pour plus d'informations, consultez la section Développer des scripts d'outil d'analyse.
Utiliser des connexions de données cohérentes à des fins de test
Pour tester en local si un script d'outil d'analyse utilise une source de données ODBC, vous devez configurer, sur votre ordinateur local, une connexion ODBC identique à la connexion dans l'environnement où sera exécuté le script d'outil d'analyse.
Éviter les chemins d'accès absolu à un fichier
Évitez d'utiliser des chemins d'accès absolu à un fichier dans des scripts d'outils d'analyse (par exemple, C:\résultats) sauf si vous êtes sûr que des chemins de fichiers identiques existent dans l'environnement d'exécution du script d'outil d'analyse.
L'utilisation de chemins d'accès relatifs au fichier comme \résultats vous permet de développer et de tester des scripts d'outils d'analyse en local, puis de les déployer dans un autre environnement sans exiger que l'autre environnement présente une structure de répertoire identique.
Utiliser SET pour les paramètres de préférence
Utilisez la commande SET pour spécifier les paramètres de préférence requis par le script d'outil d'analyse. Si vous ne spécifiez pas de préférences dans le script d'outil d'analyse, ce seront les préférences Analytics par défaut qui seront utilisées. Placez la commande SET après l'en-tête de l'outil d'analyse, mais avant toute logique de script d'outil d'analyse.
Ne pas utiliser de champs calculés dans les tables de sortie de données ou de résultats
N'utilisez pas de champs calculés dans les tables de sortie que vous prévoyez de conserver après la session d'exécution du script d'outil d'analyse.
Les tables de résultats et les tables de données conservées pour être utilisées dans des interprétations ou comme valeurs d'introduction pour des scripts ultérieurs peuvent afficher des valeurs inattendues si elles contiennent des champs calculés. Les valeurs calculées dépendent des paramètres définis dans le fichier de préférences (.prf) ou à l'aide de la commande SET et, par conséquent, des environnements différents peuvent produire des valeurs différentes.
Si vous devez conserver ces valeurs dans un champ calculé, utilisez la commande EXTRACT avec l'option FIELDS ou ALL pour convertir ce champ en champ physique dans une table de résultats ou de données. Pour plus d'informations, consultez la section Commande EXTRACT.
Chiffrer les mots de passe de connexion de données
Pour éviter d'avoir un mot de passe de source de données en texte brut dans un script d'outil d'analyse, utilisez la balise d'outil d'analyse //PASSWORD. Cette balise invite l'utilisateur à saisir un mot de passe avant l'exécution du script d'outil d'analyse, puis crypte la valeur saisie.
Utiliser un mot de passe lors de l'importation à partir de Diligent One ou de l'exportation vers Diligent One
Le paramètre PASSWORD est requis dans les commandes qui effectuent des importations à partir de Diligent One ou des exportations vers Diligent One :Diligent One
- IMPORT GRCRESULTS
- IMPORT GRCPROJECT
- EXPORT... ACLGRC
- EXPORT... HBDATA
Sans le paramètre PASSWORD, les commandes échouent dans Robots.Robots
Lorsque vous utilisez le paramètre PASSWORD dans une commande, vous devez également spécifier une balise //PASSWORD associée dans l'en-tête d'outil d'analyse. Pour plus d'informations, consultez la section balise PASSWORD.
Remarque
Le paramètre PASSWORD n’est pas requis lors de l’exécution des commandes d’importation et d’exportation dans Analytics, car le jeton d’accès à Diligent One de l’utilisateur actif, stocké localement dans le registre Windows, est utilisé automatiquement.
Éviter les interactions avec les utilisateurs
Les scripts d'outil d'analyse doivent pouvoir s'exécuter sans interaction avec l'utilisateur. Si une commande dans un script d'outil d'analyse tente de créer une boîte de dialogue, le moteur de l'environnement de déploiement interrompt le traitement du script de l'outil d'analyse et un message d'erreur est entré dans le fichier journal.
Remplacer les commandes d'interaction avec les utilisateurs par des balises d'outils d'analyse
N'utilisez pas de commandes Analytics nécessitant d'interaction avec l'utilisateur. Remplacez-les par des balises d'outils d'analyse équivalentes dans l'en-tête d'outil d'analyse. Les balises des outils d'analyse permettent aux utilisateurs d'indiquer des valeurs d'introduction avant l'exécution du script de l'outil d'analyse.
| Ne pas utiliser | Remplacer par |
|---|---|
| DIALOG | //PARAM , //TABLE , //FIELD |
| ACCEPT | //PARAM , //TABLE , //FIELD |
| PASSWORD | //PASSWORD |
| PAUSE | aucun équivalent |
Instructions
- Commandes interactives Pour éviter les échecs de traitement des scripts d'outil d'analyse, supprimez toutes les commandes interactives.
- SET SAFETY Pour vous assurer que les fichiers peuvent être, au besoin, écrasés sans afficher de boîte de dialogue de confirmation, ajoutez la commande SET SAFETY OFF au début d'un script d'outil d'analyse.
Ajoutez la commande SET SAFETY ON à la fin du script de l'outil d'analyse pour restaurer le comportement par défaut.
- Paramètre OK Pour empêcher les boîtes de dialogue de confirmation de faire échouer le script d'outil d'analyse, ajoutez le paramètre OK après les commandes qui affichent normalement une boîte de dialogue de confirmation :
- RENOMMER
- SUPPRIMER
Vérification de la syntaxe du script
Analytics fournit un outil permettant de détecter une syntaxe de script entraînant l'échec des scripts d'outil d'analyse ou nécessitant une adaptation entre votre environnement local et l'environnement de déploiement des scripts d'outil d'analyse. L'outil fournit un avertissement uniquement. Vous êtes toujours libre de transmettre ou d'importer des scripts d'outils d'analyse comportant des avertissements.
Ce que l'outil vérifie
L'outil vérifie les éléments suivants dans tous les scripts d'un projet :
- une commande nécessitant une interaction avec l'utilisateur
- un chemin de fichier absolu
- l'appel d'un script externe
Dans quels cas la vérification est effectuée
La syntaxe du script est vérifiée automatiquement lorsque vous transmettez des scripts à Robots.
La vérification automatique de la syntaxe est activée par défaut. Si vous voulez la désactiver, sélectionnez Désactiver la vérification de la syntaxe des scripts avant de transmettre des scripts dans la boîte de dialogue Options (Outils > Options > Interface).
Effectuer manuellement la vérification
Vous pouvez effectuer manuellement la vérification de la syntaxe des scripts. Vous devrez peut-être d'abord ajouter le bouton Vérifier les scripts
dans la barre d'outils Analytics.
- Si besoin, ajoutez le bouton Vérifier les scripts à la barre d'outils Analytics :
- Dans la barre d'outils, double-cliquez sur un endroit vide pour ouvrir la boîte de dialogue Personnaliser la barre d'outils.
- Dans la liste Boutons de barre d'outils disponibles, sélectionnez le bouton Vérifier les scripts, puis cliquez sur Ajouter.
- Dans la liste Boutons actuels de la barre d'outils, sélectionnez le bouton Vérifier les scripts et cliquez sur Haut ou Bas pour modifier son emplacement.
L'ordre des boutons de haut en bas correspond à leurs positions de gauche à droite, dans la barre d'outils.
Cliquez sur Fermer afin d'enregistrer vos modifications.
- Dans la barre d'outils, cliquez sur Vérifier les scripts
.Un message s'affiche pour vous indiquer si la syntaxe du script du projet est valide ou bien pour signaler un ou plusieurs avertissements.
- Effectuez l'une des actions suivantes :
- Corrigez les syntaxes de script générant un avertissement, puis recliquez sur Vérifier les scripts
pour vous assurer que les avertissements n'apparaissent plus. - Assurez-vous que l'environnement de déploiement contient une structure de répertoire ou des scripts externes qui correspondent aux chemins ou scripts externes indiqués dans le script d'outil d'analyse.
- Corrigez les syntaxes de script générant un avertissement, puis recliquez sur Vérifier les scripts