2.2 Description de Escript Validation Tool
publicité
Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 1 / 16 Escript Validation Tool 1.1 Validation des e-scripts Siebel Documentation Utilisateur 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 2 / 16 FICHE DE CONTROLE DU DOCUMENT Caractéristiques du document Statut Réf. Fichier Interne Document de travail Livrable contractuel Document Word : Documentation_Utilisateur_Escript Validation Tool_1.0.doc Mises à jour du document Version Modification 1.0 Version initiale 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 3 / 16 SOMMAIRE 1. OBJET DU DOCUMENT 4 2. DESCRIPTION DÉTAILLÉE DE L’APPLICATION 5 LANCEMENT DE L’APPLICATION DESCRIPTION DE ESCRIPT VALIDATION TOOL 2.2.1 LES ÉCRANS 2.2.1.1 Ecrans des règles 2.2.1.2 Ecrans des exécutions 2.2.1.3 Ecrans des validations réussies 2.2.1.4 Ecrans des validations en échecs 2.2.1.5 Ecrans Paramètres Validation 2.2.1.6 Ecrans des statistiques 2.2.2 LA BAR DE MENU 2.2.2.1 Le choix « Fichier » 2.2.2.2 Le choix « Langage » 2.2.2.3 Le choix « Aide » 2.1 2.2 582690257 5 6 6 6 9 10 11 12 14 15 15 16 16 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 4 / 16 1. OBJET DU DOCUMENT Ce document décrit l’utilisation de l’outil Escript Validation Tool qui permet de lancer la validation de la programmation des e-scripts de Siebel. En effet, grâce à des règles paramétrées et programmées en JAVA que l’on peut activer selon les besoins, il maintenant possible de valider automatiquement la conformité du code e-script Siebel de votre plate-forme CRM et d’obtenir une liste des lignes de codes e-scripts qui ne correspondent pas aux règles activées. Lorsque le code e-script ne respecte pas ces règles, les performances de votre plate-forme CRM Siebel peuvent être fortement diminuées et la stabilité de l’application mise en péril, d’ou la nécessité de corriger le code Siebel après avoir analysé le code Siebel avec l’outil Escript Validation Tool. 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 5 / 16 2. DESCRIPTION DETAILLEE DE L’APPLICATION 2.1 Lancement de l’application Pour effectuer le lancement de l’outil, il suffit de lancer le programme launchEVTGUI.jnlp à partir du répertoire où vous avez fait l’installation du logiciel. L’écran ci-dessous devrait apparaître, sinon, il est possible que votre licence ne soit plus valable, dans ce cas veuillez prendre contact avec la société Amigolog. 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 6 / 16 2.2 Description de Escript Validation Tool 2.2.1 Les écrans 2.2.1.1 Ecrans des règles Toutes les règles utilisées pour valider le code e-script Siebel sont affichées dans cet onglet. Il est possible de modifier, supprimer ou ajouter une règle. Attention, l’ajout d’une règle dans cet outil nécessite l’implémentation d’une nouvelle classe java pour intégrer cette nouvelle règle dans le moteur de validation. Pour ce type de modifications, veuillez contacter la société Amigolog. A) Ecrans des règles actives Sur ce premier écran, vous retrouvez la liste des règles actives qui seront utilisées lors du traitement de validation des e-scripts Siebel. 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 7 / 16 Description des champs principaux Champs Description Qualification Indicateur du niveau de problème Description Conséquence Paramètre Obligatoire Actif Classe Java Description de la règle Conséquence du problème Paramètre à passer au moteur de validation pour certaine règle Importance de la règle Permet d’activer ou non cette règle Représente la classe java qui est utilisée par cette règle Description des boutons actifs Créer une règle Effacer une règle Enregistrer la règle 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 8 / 16 B) Ecrans de toutes les règles Le fonctionnement et les champs sont identiques à ceux des règles actives (Voir paragraphe ci-dessus) 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 9 / 16 2.2.1.2 Ecrans des exécutions En cliquant sur l’onglet Exécution, vous aurez l’historique de tous les lancements du moteur de validation 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 10 / 16 2.2.1.3 Ecrans des validations réussies En cliquant sur l’onglet validation réussies, vous aurez pour la dernière validation exécutée, la liste des fonctions e-scripts qui sont conformes aux règles paramétrées. Description des champs principaux Champs Description Repository Nom Objet Fonction Commentaires Nom de la repository Siebel testée Nom de l’objet java Nom de la fonction java Ligne de commentaires du moteur de validation 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 11 / 16 2.2.1.4 Ecrans des validations en échecs En cliquant sur l’onglet validation en échecs, vous aurez pour la dernière validation exécutée, la liste des occurences e-scripts qui ne sont pas conformes aux règles paramétrées. Description des champs principaux Champs Description Repository Nom Objet Fonction Numéro de ligne Ligne de script Commentaires Nom de la repository Siebel testée Nom de l’objet java Nom de la fonction java Numéro de ligne du problème Ligne de script à problème Description du problème par le moteur de validation 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 12 / 16 2.2.1.5 Ecrans Paramètres Validation En cliquant sur l’onglet paramètres Validation, vous aurez les paramètres nécessaires au fonctionnement du moteur de validation qui sont initialisés par défaut, mais peuvent nécessités des adaptation suivant votre installation. 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 13 / 16 Description des champs principaux Champs Date de départ des modifications à contrôler Hôte base de données locale Tools Port base de données locale Tools Utilisateur base de données locale Tools Mot de passe base de données locale Tools Nom base de données locale Tools Nom du Siebel DB Owner Nom du Siebel repository Répertoire des fichiers de sortie Chemin complet du moteur de BDD Siebel Chemin complet de la base Siebel Tools Description Date de départ des modifications des e-scripts Siebel Seuls les objets modifiés après cette date seront considérés par l’outil lors de la prochaine validation. Nom de la machine sur lequel la base locale Siebel Tools est installée, par défaut localhost Numéro de port utilisé par la base de données locale Siebel Tools, par défaut 2638 Utilisateur de la base de donnée Siebel Tools, par défaut DBA Mot de passe de l’utilisateur de la base de donnée Siebel Tools, par défaut SQL Nom de la base de donnée Siebel Tools, par défaut sse_data Nom du propriétaire de la base Siebel Tools, par défaut SIEBEL Nom de la repository Siebel, par défaut Siebel Repository Répertoire utilisé pour l’export des résultats et des statistiques, par défaut C:\temp Chemin complet vers le moteur de base de données Siebel Tools, par défaut C:\bustools\st75x\bin\dbeng8.exe Chemin complet vers la base de données locale Siebel Tools, par défaut C:\bustools\st75x\LOCAL\sse_data.dbf Description des boutons actifs Enregistrer la règle 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 14 / 16 2.2.1.6 Ecrans des statistiques En cliquant sur l’onglet Statistiques, vous aurez pour la dernière validation effectuée, le nombre de lignes de code testées par Type d’objet et Fonction Description des champs principaux Champs Description Type d’objet Nom d’objet Fonction Nombre de lignes Lignes de code Type de l’objet Nom de l’objet Nom de la fonction Nombre de ligne total dans la fonction Nombre de lignes avec du code, hors lignes blanches et lignes en commentaire 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 15 / 16 2.2.2 La bar de Menu 2.2.2.1 Le choix « Fichier » Ce menu est composé de 4 choix : A) Exécution de la validation Ce choix permet de lancer le moteur de validation des e-scripts Siebel Lors de son lancement, l’indication que le traitement est en cours est affiché en bas de l’écran : Une fois le traitement fini, ce message disparaîtra et les écrans se rafraîchiront avec les nouvelles informations. B) Export des résultats Ce choix vous permet d’exporter le résultat de la validation et de visualiser le résultat directement dans EXCEL. Le répertoire destination est paramétré dans l’onglet ‘Paramètres Validation’ (voir paragraphe 2.2.1.5). C) Export des statistiques Ce choix vous permet d’exporter les statistiques générées lors de la dernière validation et de visualiser le résultat directement dans EXCEL. Le répertoire destination est paramétré dans l’onglet ‘Paramètres Validation’ (voir paragraphe 2.2.1.5). D) Quitter Pour quitter l’application Escript Validation Tool 582690257 Mis à jour le : 17/04/2017 Documentation utilisateur Escript Validation Tool Documentation Utilisateur v.1.0 16 / 16 2.2.2.2 Le choix « Langage » A) Changer les libellés de l’application en Anglais Les libellés utilisés dans le logiciel seront changés en Anglais, lorsque l’on est en Français. B) Changer les libellés de l’application en Français Les libellés utilisés dans le logiciel seront changés en Français, lorsque l’on est en Anglais. 2.2.2.3 Le choix « Aide » A) Afficher les Messages d’erreurs Affiche les logs correspondant aux erreurs éventuelles détectées lors de l’exécution de l’application. B) A propos … 582690257 Affiche une boîte de message « A propos » avec le Copyright de l’outil. Mis à jour le : 17/04/2017
