Scripts d'outil d'analyse

L'exécution de scripts ne se limite pas à Analytics uniquement. En convertissant des scripts classiques en script d'outil d'analyse, vous pouvez planifier et exécuter des scripts dans l'application Robots sur la plateforme HighBond ou dans Analytics Exchange. Vous pouvez aussi exécuter des scripts d'outil d'analyse dans la fenêtre App Analyse, un composant amovible d'Analytics.

Que sont des scripts d'outils d'analyse ?

Un "outil d'analyse" ou script d'outil d'analyse correspond à un script comportant un en-tête d'outil d'analyse. L'en-tête d'outil d'analyse est une série de balises déclaratives qui permet au script de s'exécuter dans Robots, sur AX Serveur ou dans la fenêtre App Analyse. L'en-tête de l'outil d'analyse comprend des paramètres d'entrée que l'utilisateur renseigne au préalable permettant ainsi d'exécuter le script d'outil d'analyse de manière autonome, immédiatement ou à une heure planifiée.

Astuce

Les script d'outils d'analyse sont généralement exclusivement développés et testés dans Analytics, qui permet un développement plus aisé. Utilisez le client AX pour effectuer des mises à jour simples au niveau des scripts d'outils d'analyse existants qui sont stockés dans le serveur AX.

Qu'est-ce qu'une App Analyse ?

Une App Analyse correspond à un projet Analytics créé pour une utilisation dans Analytics Exchange ou dans la fenêtre App Analyse. Les apps Analyse contiennent un ou plusieurs scripts d'outils d'analyse, mais elles peuvent aussi contenir des tables de données et des interprétations.

Remarque

Les Apps Analyse sont généralement créées ou développées par les experts en script internes d'une organisation ou par des accords avec des consultants de Diligent.

Passer des scripts classiques en scripts d'outil d'analyse

Des scripts d'outil d'analyse commencent par des scripts classiques. Pour exécuter un script classique dans Robots, sur AX Serveur ou dans la fenêtre App Analyse, vous devez convertir le script classique en script d'outil d'analyse :

  1. Créez et testez un script dans Analytics.
  2. Ajoutez les balises d'en-tête d'outils d'analyse qui conviennent pour transformer le script en script d'outil d'analyse.
  3. Compressez le script d'outil d'analyse pour l'exécuter sur AX Serveur ou dans la fenêtre App Analyse. Ne compressez pas les scripts d'outil d'analyse exécutés dans Robots.

Pour plus d'informations, consultez la section Développer des scripts d'outil d'analyse.

Ajouter des en-têtes d'outils d'analyse

Les en-têtes d'outils d'analyse sont définis dans un bloc de commentaire qui commence à la première ligne du script. Au minimum, un en-tête d'outil d'analyse déclare que le script est un script d'outil d'analyse :

COMMENT
//ANALYTIC Identifier les chèques manquants
Ce script d'outil d'analyse identifie les numéros de chèque manquants
END

Pour plus d'informations, consultez la section Utilisation des en-têtes des outils d'analyse.

En quoi consiste un script auxiliaire ?

Un script auxiliaire est un script ordinaire sans en-tête d'outil d'analyse conçu pour fonctionner conjointement avec un script d'outil d'analyse. Dans une conception normale, un script d'outil d'analyse utilise la commande DO SCRIPT pour appeler un ou plusieurs scripts auxiliaires. Une fois qu'un script auxiliaire est terminé, le traitement revient au script d'outil d'analyse, qui continue à s'exécuter.

Les scripts auxiliaires peuvent également être désignés sous le nom de sous-scripts, de scripts secondaires, de scripts utilitaires ou de scripts d'aide. Vous n'êtes pas obligé d'utiliser des scripts auxiliaires. Ils offrent une option permettant de compartimenter des blocs de logique de script qui peuvent être conditionnels, réutilisables ou simplement difficiles à inclure dans le script d'outil d'analyse parent.

Restrictions sur les scripts auxiliaires

Les scripts auxiliaires peuvent être utilisés de différentes manières, mais comme il n'existe pas d'en-tête d'outil d'analyse, deux restrictions s'appliquent :

  • Aucune balise d'entrée ou de sortie vous ne pouvez pas spécifier de balises d'analyse d'entrée ou de sortie, ce qui implique que vous ne pouvez pas créer de paramètres d'entrée ou de sortie dans le script auxiliaire proprement dit. Les éventuels paramètres requis doivent être créés dans l'en-tête d'outil d'analyse du script d'outil d'analyse parent.
  • Ne peut pas être exécuté directement les utilisateurs ne peuvent pas programmer ou exécuter directement des scripts auxiliaires. Ils ne peuvent être appelés qu'à partir d'un script d'outil d'analyse, soit directement soit indirectement par un autre script auxiliaire.

Diffuser et exécuter des scripts d'outil d'analyse

Plusieurs options permettent de diffuser et d'exécuter des scripts d'outil d'analyse en fonction des produits et composants Diligent utilisés par votre organisation.

App/produit/composant Méthode de diffusion et d'exécution d'un script d'outil d'analyse
Robots
  • Transmettre un ou plusieurs scripts d'outils d'analyse et scripts auxiliaires sous forme de version de script en mode développement dans Robots ainsi que planifier et exécuter une version activée en mode production
Serveur AX

Une de ces méthodes :

  • importer le projet Analytics (fichier .acl) directement dans AX Serveur, et planifier et exécuter un script d'outil d'analyse à l'aide d'AX Client
  • compresser le projet dans un fichier App Analyse compressé (fichier .aclapp ), l'importer dans AX Serveur, et exécuter un script d'outil d'analyse à l'aide du Client Web d'AX

    Pour plus d'informations, consultez la section Compresser des Apps Analyse à importer dans AX Serveur.
Fenêtre App Analyse

Déterminer l'environnement d'exécution d'un script d'outil d'analyse

Si vous souhaitez créer un script d'outil d'analyse capable de s'exécuter à la fois dans Analytics, dans Analytics Exchange ou dans la fenêtre App Analyse, il convient de déterminer l'environnement d'exécution pendant l'exécution du script. Vous pouvez utiliser ces informations pour prendre des décisions quant aux commandes à exécuter à partir de l'emplacement d'exécution du script.

Utilisez la fonction FTYPE( ) pour déterminer l'emplacement d'exécution du script :

FTYPE("ax_main") = "b"

Si le script s'exécute dans Analytics Exchange ou dans la fenêtre App Analyse, l'expression est évaluée sur vrai (T). Pour les scripts s'exécutant dans Analytics, l'expression est évaluée sur faux (F). Pour plus d'informations, consultez la section Fonction FTYPE( ).

Identifier l'utilisateur exécutant le script sur AX Serveur

Pour les outils d'analyse exécutés sur AX Serveur, vous pouvez utiliser la variable système AXRunByUser afin d'identifier le nom de l'utilisateur qui exécute actuellement le script au format domaine\nom_utilisateur :

EXTRACT FIELDS TIME() AS "Heure"; DATE() AS "Date"; AXRunByUser AS "Utilisateur actuel" TO R_RunRecord APPEND

Remarque

AXRunByUser est uniquement disponible lors de l'exécution des scripts d'outil d'analyse sur AX Serveur. La variable n'est pas reconnue lors de l'exécution de scripts dans Analytics.