Création et modification de scripts

Pour créer des scripts, plusieurs possibilités s'offrent à vous :

  • Éditeur de scriptTaper la syntaxe du script dans la fenêtre Éditeur de script
  • Trace des commandesCopier la syntaxe du script à partir de la trace des commandes
  • enregistrement des scriptsEnregistrer la syntaxe des commandes à mesure que vous les exécutez
  • Capture de syntaxeInsérer la syntaxe des commandes à mesure que vous les sélectionnez dans l’interface utilisateur sans les exécuter
  • Historique de la tableCopier la syntaxe d’un script à partir de l’historique d’une table de sortie

Vous pouvez utiliser ces options en les associant. Par exemple, vous pourriez commencer un script en copiant la syntaxe à partir de la trace des commandes, puis ajouter des lignes de syntaxe supplémentaires directement dans la fenêtre Éditeur de script.

Pour modifier un script existant dans Analytics, vous devez utiliser l'éditeur de script.

Vous avez aussi la possibilité d'utiliser l'éditeur de texte de votre choix, et de copier-coller la syntaxe dans un script Analytics.

Saisie semi-automatique du code

Lorsque vous saisissez de la syntaxe de script dans l'éditeur de script, Analytics procède à différents types de saisie semi-automatique. La saisie semi-automatique de code permet de réduire les tâches de saisie de syntaxe, tout en présentant sous leur forme correcte les commandes, les fonctions, les mots-clés et les paramètres ACLScript.

  • Saisie semi-automatique de commandes, de fonctions et de mots-clésLorsque vous commencez à taper des caractères, la fonctionnalité de saisie semi-automatique propose une liste de sélection de commandes, de fonctions et de mots-clés ACLScript correspondant aux caractères saisis. Vous pouvez sélectionnez un élément de la liste pour compléter automatiquement l’élément de syntaxe.

  • Message d’aide pour les paramètres de fonctionsLorsque vous saisissez la parenthèse ouvrante après un nom de fonction valide, un message d’aide affiche le type de données de la sortie renvoyée par la fonction, ainsi que le format requis pour les paramètres de la fonction.

  • Fermeture automatique des paires d’éléments de syntaxeLorsque vous saisissez le caractère ouvrant de n’importe quelle paire d’éléments de syntaxe ci-dessous, le caractère fermant sera automatiquement inséré :

    • Guillemets doubles ""

    • Guillemets simples ''

    • Guillemets arrière ``

    • Parenthèses ()

Vous pouvez désactiver la saisie semi-automatique de commandes, de fonctions et de mots-clés en sélectionnant Désactiver la saisie semi-automatique dans les scripts dans l'onglet Interface dans la boîte de dialogue Options (Outils > Options).

Le message d’aide pour les paramètres de fonctions ainsi que la fermeture automatique des éléments de syntaxe les plus courants ne peuvent pas être désactivés.

Créer ou modifier un script dans l'Éditeur de script

Créez ou modifiez des scripts en tapant la syntaxe ACLScript requise directement dans l'éditeur de script ou en utilisant l'une des autres méthodes de saisie de syntaxe prises en charge.

Note

Lorsque vous ajoutez des commandes ACLScript à un script, vous devez suivre les règles de syntaxe suivantes concernant les sauts de ligne :

  • Chaque commande doit être saisie sur une ligne distincte. Deux commandes ne peuvent pas occuper la même ligne (même numéro de ligne).

  • Presque toutes les commandes ACLScript doivent être saisies sur une seule ligne (numéro de ligne unique). Les commandes sur une seule ligne ne peuvent pas être réparties sur plusieurs lignes. Les commandes sur plusieurs lignes doivent respecter la syntaxe requise pour les lignes multiples. Consultez les rubriques d’aide de chaque commande pour connaître la syntaxe requise. Consultez la section Commandes.

Créer ou modifier le script

  1. Appliquez l'une des étapes suivantes pour ouvrir le script dans l'Éditeur de script :
    • Pour créer un script, sélectionnez Fichier > Nouveau > Script.

      Le script est créé et nommé Nouveau_Script. Pour renommer le script, cliquez avec le bouton droit de la souris sur le nom, puis sélectionnez Renommer.

      Note

      La longueur des noms de scripts est limitée à 64 caractères alphanumériques. Le nom peut inclure le caractère de soulignement ( _ ), mais aucun autre caractère spécial ni espace. Le nom ne peut pas commencer par un chiffre.

    • Pour ouvrir un script existant, cliquez avec le bouton droit de la souris sur ce dernier dans l'onglet Vue globale du Navigateur.
  2. Ajoutez, modifiez ou supprimez la syntaxe ACLScript dans l'éditeur de script.

    Astuce

    Vous pouvez utiliser ces trois touches de raccourcis pour les actions courantes :

    • Ctrl+ZAnnuler une ou plusieurs actions
    • Ctrl+YRefaire une ou plusieurs actions
    • Ctrl+SEnregistrer le projet Analytics, y compris le script ouvert
  3. (Facultatif) Placez le curseur à un endroit approprié dans un script, puis effectuez une ou plusieurs des étapes suivantes pour insérer un ou plusieurs éléments spécifiques :
    ÉlémentÉtapes

    Nom de l'élément de projet

    (table, script, vue, environnement de travail ou index)

    1. Cliquez avec le bouton droit de la souris, puis sélectionnez Insérer > Élément de projet.
    2. Sélectionnez le type d'élément dans la liste déroulante Type d'élément.
    3. Sélectionnez un ou plusieurs noms d'éléments, puis cliquez sur OK.
    Nom de champ
    1. Dans la barre d'outils Éditeur de script, cliquez sur Insérer un champ .
    2. Sélectionnez un ou plusieurs noms de champs, puis cliquez sur OK.
    Expression
    1. Dans la barre d'outils Éditeur de script, cliquez sur Insérer une expression .
    2. Créez une expression, puis cliquez sur OK.
    Boîte de dialogue
    1. Dans la barre d'outils Éditeur de script, cliquez sur Construction d'une nouvelle boîte de dialogue .
    2. Créez une boîte de dialogue personnalisée, cliquez sur Fermer, puis cliquez sur OK.

    Pour plus d'informations, consultez la section Création de boîtes de dialogue personnalisées.

    Date et heure
    1. Cliquez avec le bouton droit de la souris et sélectionnez Insérer > Date & heure.
    2. Indiquez ou sélectionnez une date, une DateHeure ou une heure, puis cliquez sur OK.
    Jeton Diligent One

    Pour de plus amples informations, consultez la section Obtenir un jeton d’accès Jeton d’accès Diligent One One.

  4. Sélectionnez Fichier > Enregistrer le projet.
  5. Cliquez sur Oui dans la boîte de dialogue de confirmation.

Surligner les termes ou les éléments de syntaxe répétés

Vous pouvez mettre en surbrillance les termes répétés dans un script tels que des noms de table, de champ, de variable ou de mot-clé. Vous pouvez également mettre en surbrillance les éléments de syntaxe répétés tels que les parenthèses et les guillemets.

La capacité à mettre en surbrillance l’ensemble des occurrences d’un terme ou d’un élément de syntaxe particulier constitue une fonctionnalité utile de développement de script et de débogage.

  • ConditionsAfin de mettre en surbrillance plusieurs instances d’un terme, double-cliquez sur une seule instance du terme n’importe où dans le script.

  • ExpressionAfin de mettre en surbrillance plusieurs instances d’une expression, sélectionnez une seule instance de l’expression n’importe où dans le script.

Note

Le comportement de la mise en surbrillance ne répondra pas toujours exactement à vos attentes. Par exemple, si vous sélectionnez avec un nom de variable les signes de pourcentage % qui l'entourent, il est possible que les autres instances de la variable ne soient pas mises en surbrillance. Double-cliquez sur le nom de la variable à la place pour une mise en surbrillance plus cohérente sur l’ensemble du script.

Mettre en surbrillance les parenthèses correspondantes

Vous pouvez mettre en surbrillance les parenthèses correspondantes dans une expression, par exemple une fonction avec des paramètres imbriqués. La capacité à mettre en surbrillance les parenthèses ouvrantes et fermantes dans des expressions complexes permet d’accélérer le codage et de réduire le risque d’erreur lié à la création d’une expression avec des parenthèses non correspondantes.

Pour mettre en surbrillance des parenthèses correspondantes, positionnez le curseur juste avant ou juste après une seule parenthèse dans un script. Les deux parenthèses, ouvrante et fermante, seront mises en surbrillance. Si les parenthèses correspondantes ne sont pas mises en surbrillance, cela signifie que l’une des parenthèses de la paire est manquante.

Modifier la syntaxe des commandes avec une boîte de dialogue

Plutôt que de modifier manuellement les commandes d'un script, vous pouvez les modifier à l'aide de la boîte de dialogue associée.

Note

Cette méthode est uniquement disponible pour les commandes ayant des boîtes de dialogue.

  1. Sélectionnez une commande ACLScript existante dans le script.
  2. Dans la barre d'outils Éditeur de script, cliquez sur Modifier la commande .

    La boîte de dialogue s'ouvre.

  3. Dans la boîte de dialogue, apportez les modifications requises aux paramètres des commandes, puis cliquez sur OK.

    La syntaxe du script est mise à jour.

Ouvrir deux scripts côte à côte

Vous avez la possibilité d’ouvrir deux scripts côte à côte dans l’éditeur de script, ce qui permet de les comparer facilement et de copier la syntaxe de script entre eux.

  1. Dans l’onglet Vue globale du Navigateur, sélectionnez les deux scripts que vous souhaitez ouvrir côte à côte.

    Vous pouvez utiliser la combinaison Ctrl+clic pour sélectionner deux scripts non adjacents, ou Maj+clic pour sélectionner des scripts adjacents.

  2. Effectuez un clic droit sur l’un des scripts sélectionnez, puis sélectionnez Modifier Côte à côte.

    Les deux scripts s’ouvrent en mode côte à côte.

  3. Cliquez dans le corps de l’un des deux scripts pour passer de l’un à l’autre.

    Si vous utilisez la couleur d'arrière-plan par défaut dans l'éditeur de script, le script actif disposera d'un arrière-plan plus clair.

  4. Pour enregistrer les modifications effectuées dans l’un des deux scripts ou dans les deux, procédez à l’une des actions suivantes :

    • Appuyez sur Ctrl+S, puis cliquez sur Oui dans la/les boîte(s) de dialogue de confirmation.

    • Dans la barre d’outils, cliquez sur Enregistrer le projet actif, puis cliquez sur Oui dans la/les boîte(s) de dialogue de confirmation.

  5. Pour quitter le mode côte à côte, cliquez sur l’icône Fermer dans l’onglet du script.

    Les deux scripts s'ouvrent dans des onglets différents de l'éditeur de script.

Tester le script

Pour tester le script en l'exécutant ou en le suivant par étape, cliquez sur Exécuter  ou sur Étape  dans la barre d'outils Éditeur de script.

Note

Si vous exécutez un script ou le suivez par étape, tous les scripts ouverts sont automatiquement enregistrés.

Créer un script à partir de la trace des commandes

Vous pouvez copier les entrées de trace dans l'onglet Trace du Navigateur en tant que point de départ pour la création d'un script ou les ajouter à un script existant. La syntaxe de chaque commande exécutée précédemment dans Analytics est enregistrée dans une entrée de trace individuelle.

Vous pouvez sélectionner les types d'entrées de trace suivants et les copier dans un nouveau script ou dans un script existant :

  • entrées individuelles
  • une série d'entrées associées à une table
  • de grands groupes d'entrées associées à une session ou à une période
  1. Dans le Navigateur, cliquez sur l'onglet Trace pour afficher la trace.
  2. Sélectionnez l'entrée ou le groupe d'entrées de la trace que vous souhaitez inclure dans le script.

    Si vous sélectionnez des éléments de niveau supérieur dans l'arborescence, les sous-entrées sont sélectionnées automatiquement.

  3. Effectuez l'une des actions suivantes :
    Créer un nouveau script
    1. Cliquez avec le bouton droit de la souris sur l'onglet Trace et sélectionnez Enregistrer les éléments sélectionnés > Script.
    2. Dans la boîte de dialogue Enregistrer le script sous, entrez le nom du nouveau script et cliquez sur OK.

      Note

      La longueur des noms de scripts est limitée à 64 caractères alphanumériques. Le nom peut inclure le caractère de soulignement ( _ ), mais aucun autre caractère spécial ni espace. Le nom ne peut pas commencer par un chiffre.

      Le nouveau script est ajouté à l'onglet Vue globale dans le Navigateur. Le script est enregistré dans le dossier contenant la table Analytics active ou dans le dossier du projet racine si aucune table n'est ouverte.

    Copier la syntaxe dans un script existant
    1. Cliquez avec le bouton droit de la souris dans l'onglet Trace, puis sélectionnez Copier.
    2. Ouvrez un script existant si aucun script n'est déjà ouvert.
    3. Dans l'éditeur de script, placez le curseur à l'emplacement au niveau duquel insérer la syntaxe copiée.
    4. Cliquez avec le bouton droit de la souris, puis sélectionnez Coller.

Créer un script à partir de la fonction d'enregistrement des scripts

La fonction d'enregistrement des scripts d'Analytics permet de créer un script en enregistrant vos actions lorsque vous manipulez des tables et des commandes dans l'interface utilisateur d'Analytics. Grâce à la fonction d'enregistrement des scripts pour créer des scripts, vous n'êtes pas obligé d'entrer manuellement la syntaxe requise pour chaque commande ACLScript utilisée ni même d'en connaître la syntaxe.

Seules les commandes sont capturées par la fonction d'enregistrement des scripts. En règle générale, si la commande apparaît dans la trace des commandes, elle peut être saisie dans un script par l'enregistrement des scripts.

Astuce

La fonction d'enregistrement des scripts est un outil utile pour vous permettre de vous familiariser avec ACLScript. Via cette fonction , vous pouvez enregistrer une procédure d'analyse et afficher le script produit, afin de consulter la série de commandes et la syntaxe requises pour la reproduction du comportement dans un script.

  1. Dans le menu principal Analytics, sélectionnez Outils > Activer l'enregistrement des scripts.

    L'icône de la fonction d'enregistrement des scripts est affichée dans la barre d'état. Une case à cocher apparaît à gauche de l'élément de menu afin d'indiquer que l'enregistrement des scripts est activé.

  2. Effectuez la procédure d'analyse ou de traitement à enregistrer.

    Analytics enregistre chaque commande traitée dans un nouveau script.

  3. Une fois le traitement ou l'analyse des données terminé, sélectionnez Outils > Activer l'enregistrement des scripts à nouveau pour désactiver l'enregistrement des scripts.

    Analytics vous invite à enregistrer le script.

  4. Entrez un nom significatif pour le script dans la zone de texte et cliquez sur OK.

    Note

    La longueur des noms de scripts est limitée à 64 caractères alphanumériques. Le nom peut inclure le caractère de soulignement ( _ ), mais aucun autre caractère spécial ni espace. Le nom ne peut pas commencer par un chiffre.

Créer un script avec la capture de syntaxe

La capture de syntaxe vous permet d'utiliser les menus et boîtes de dialogue Analytics pour insérer automatiquement la syntaxe ACLScript dans un script.

  1. Ouvrez le script à utiliser.
  2. (Facultatif) Ouvrez la table à utiliser.

    Astuce

    Si vous commencez la capture de syntaxe avant d'ouvrir une table, cette dernière ne s'ouvre pas physiquement dans l'onglet Vue car les commandes ne sont pas réellement exécutées pendant la capture de syntaxe. Il se peut que vous trouviez cela difficile de visualiser les commandes suivantes sans table ouverte pour mieux vous guider.

  3. Dans la barre d'outils Éditeur de script, cliquez sur Démarrer la capture de syntaxe .
  4. Effectuez la procédure d'analyse ou de traitement à enregistrer.

    La syntaxe associée est insérée automatiquement dans le script. Les commandes elles-mêmes ne sont pas exécutées.

  5. Cliquez sur Terminer la capture de syntaxe  pour arrêter l'insertion de la syntaxe de la commande dans le script.

Créer un script à partir de l'historique de la table

Vous pouvez créer un script à partir de l'historique associé à une sortie ou à une table de résultats Analytics.

Par exemple, si vous ajoutez une table d'inventaire mensuelle dans un projet Analytics et que vous extrayez les divisions et les éléments appropriés dans une nouvelle table, vous pouvez créer un script pour ce processus en fonction de l'historique de la table associée à la première table de sortie que vous avez créée.

Chaque table créée comme sortie d'une commande Analytics conserve un enregistrement des commandes utilisées pour la créer, y compris celles qui ont permis de générer des tables intermédiaires entre la table Analytics d'origine et la table de sortie. Vous pouvez copier cet historique de table dans un nouveau script que vous pourrez ensuite utiliser pour automatiser la création des tables de sortie ultérieures.

  1. Ouvrez une table de sortie qui est le résultat d'un processus que vous souhaitez automatiser dans un script.

  2. Sélectionnez Outils > Créer le script à partir de l'historique de la table.

    Si la Vue_Par_Défaut est active, Analytics vous invite à renommer la vue pour empêcher son écrasement lors de l'exécution du nouveau script.

  3. Si Analytics vous invite à renommer cette vue, cliquez sur Renommer, indiquez un nouveau nom, puis cliquez sur OK.

  4. Dans la boîte de dialogue Enregistrer sous, entrez le nom du nouveau script et cliquez sur OK.

    Note

    La longueur des noms de scripts est limitée à 64 caractères alphanumériques. Le nom peut inclure le caractère de soulignement ( _ ), mais aucun autre caractère spécial ni espace. Le nom ne peut pas commencer par un chiffre.

  5. (Facultatif) Ouvrez et modifiez le nouveau script si vous souhaitez ajuster une partie du comportement de script.

    Par exemple, plutôt que d'écraser la table d'origine, vous pourriez décider d'enregistrer la sortie dans une table portant un autre nom.

Importer des scripts ou des snippets à partir du Portail développeur Diligent

Une autre possibilité pour créer des scripts consiste à utiliser les échantillons de code ACLScript disponibles dans le Portail développeur Diligent. Le portail contient un certain nombre de ressources pour les développeurs qui travaillent avec les produits Diligent, notamment une bibliothèque Web d’éléments scriptés par Analytics développés par les employés Diligent. Dans le cadre de votre abonnement, vous pouvez télécharger et utiliser tous ces éléments scriptés.

Téléchargez les éléments scriptés à partir de Portail développeur Diligent, puis importez-les dans Analytics.

Note

Vous pouvez utiliser un élément scripté tel quel ou le personnaliser en fonction de vos besoins.

Téléchargez les éléments scriptés à partir de la page Échantillons de code

  1. Accédez à la page Échantillons de code dans le Portail développeur Diligent.

  2. Sélectionnez Connexion en haut à droite et connectez-vous à l’aide de votre compte Diligent One.

  3. Dans la page Échantillons de code, recherchez l’élément que vous souhaitez utiliser et sélectionnez-le.

  4. Consultez les informations relatives aux prérequis, aux conditions requises en matière de données et aux limitations.

  5. Si l’élément correspond à vos besoins, sélectionnez l’icône de téléchargement dans le panneau Fichiers pour télécharger l’élément sous forme de fichier *.aclscriptsur votre ordinateur.

    Si plusieurs éléments existent sous Fichiers, téléchargez tous les éléments. Il existe une dépendance entre les éléments.

  6. Si la section Snippets de code dépendants existe dans le panneau Fichiers, vous pouvez accéder à ces éléments et les télécharger.

Importer un élément scripté dans Analytics

  1. Ouvrez le projet Analytics que vous souhaitez utiliser pour importer l’élément scripté.

  2. Dans l’onglet Vue d’ensemble du navigateur, cliquez avec le bouton droit sur le dossier que vous souhaitez utiliser pour l’élément scripté et sélectionnez Importer un élément de projet > Script.

  3. Accédez à l’élément téléchargé, sélectionnez-le, puis sélectionnez Ouvrir.

    L’élément scripté est importé depuis Analytics et placé dans le dossier que vous avez spécifié.

  4. Sélectionnez OK dans la boîte de dialogue de confirmation.

  5. Répétez le processus pour tous les éléments supplémentaires que vous avez téléchargés.

  6. Double-cliquez sur un élément importé pour l’afficher dans l’éditeur de script.

Obtenir un jeton d’accès Jeton d’accès Diligent One One

Attention

Le jeton d'accès généré correspond au compte utilisé pour se connecter à la Barre de lancement. En tant que rédacteur de scripts, indiquer votre propre jeton d'accès dans un script n'est peut-être pas très approprié si le script sera utilisé par d'autres personnes.

Protégez les jetons d’accès comme n’importe quel mot de passe de compte.

Utilisez un jeton d'accès existant sauf si vous avez une bonne raison d'en créer un nouveau. Si le jeton existant ne fonctionne pas, créez-en un nouveau. L'utilisation d'un jeton existant réduit le nombre de jetons que vous devez gérer.

  1. Effectuez l'une des actions suivantes :

    • Dans le menu principal Analytics, sélectionnez Outils > Jeton d’accès Diligent One.

    • Dans l'Éditeur de script, cliquez avec le bouton droit de la souris, puis sélectionnez Insérer > Jeton Diligent One.

    La page Gérer des jetons API s'ouvre dans votre navigateur. Il se peut que vous deviez d'abord vous connecter à la Barre de lancement.

    L'accès à la page Gérer des jetons API via Analytics est une fonctionnalité d'ordre pratique. Vous pouvez également vous connecter à Diligent One et accéder à la page via votre profil utilisateur sans l'aide d'Analytics.

  2. Effectuez l'une des actions suivantes :

    • Utiliser un jeton existant

      1. Dans la colonne Jeton, cliquez sur le jeton en partie masqué que vous voulez utiliser.

      2. Saisissez votre mot de passe Diligent One et cliquez sur Confirmer

        Le jeton démasqué s'affiche.

      3. Cliquez sur Copier pour copier le jeton.

        Astuce

        Ne fermez pas la boîte de dialogue contenant le jeton tant que vous n'avez pas fini de copier-coller le jeton.

    • Créer un nouveau jeton

      1. Cliquez sur Ajouter un jeton > Analytics.

      2. Dans le panneau latéral Nouveau jeton Analytics, indiquez les informations suivantes :

        Champ ou option Description
        Description

        Saisissez une description qui fournit des informations utiles, telles que :

        • L'objet du jeton
        • L'emplacement d'utilisation du jeton : par exemple, le nom et l'emplacement du script Analytics, ou le nom et l'emplacement des tâches du robot
        Expiration du jeton
        • ActivéLe jeton expire au bout du nombre de jours que vous avez spécifié
        • DésactivéLe jeton n’expire pas

        Note

        Votre organisation dispose peut-être d'une politique de sécurité qui demande à ce que les jetons expirent au bout d'un certain temps. Créer des jetons avec une date d'expiration est une bonne pratique. Diligent One vous envoie une notification automatique par e-mail quelques jours avant la date d'expiration.
        Expire dans Indiquez le nombre de jours avant l'expiration du jeton (de 1 à 365)
        Mot de passe Saisissez le mot de passe de votre compte Diligent One One.

      3. Cliquez sur Générer un jeton.

      4. Cliquez sur Copier pour copier le jeton.

        Astuce

        Ne fermez pas le panneau latéral contenant le jeton tant que vous n'avez pas fini de copier-coller le jeton.

  3. Selon la méthode de définition de mot de passe utilisée, effectuez l'une des actions suivantes :

    • Balise d’analyse de données PASSWORDDans le Concepteur de tâches d’un robot ACL, collez le jeton copié dans un champ de paramètre de mot de passeRobot ACL robot

    • Commande PASSWORDDans Analytics, collez le jeton copié dans l’invite de mot de passe qui apparaît lors de l’exécution du script.

    • Commande SET PASSWORDDans Analytics, collez le jeton à l’endroit approprié dans la syntaxe de la commande SET PASSWORD dans un script

  4. Dans la barre de lancement, fermez la boîte de dialogue ou le panneau latéral contenant le jeton.

    Si vous avez créé un nouveau jeton, une version partiellement masquée du jeton est ajoutée en haut de votre liste de jetons.

    Pour de plus amples informations, consultez la section Créer et gérer Jetons d’accès Diligent One.