====== Exécution planifiée ======

Lancer de manière automatique, à intervalles réguliers, une requêtes ou un ensemble de requêtes est un besoin courant en entreprise. C'est pourquoi Vigilens vous propose un mécanisme de planification de vos requêtes.

===== Principe =====

Il s'agit tout simplement d'utiliser le [[https://en.wikipedia.org/wiki/Windows_Task_Scheduler|planificateur de tâches Windows]] pour lancer une ligne de commande. Vous pouvez utiliser soit le langage de scripts classique (cmd) soit de PowerShell.

Ex : ''C:\Vigilens\app\Vigilens.exe /vglAuto="C:\Vigilens\Work\Archives\DEMO\Cohérence\Cohérence 1 min" /vglUser="SCHEDULE_FR"''
===== Paramétrage =====

Il se fait dans le [[:v8_0_0:admintool:menus:accueil:start#execution_automatique|menu Exécution automatique de l'AdminTool]].

Il faut définir la liste des utilisateurs qui pourront se connecter via une ligne de commande.

{{:v8_0_0:howto:faa09f498d1d36583bb796df4130e68d.png?nolink&500}}

===== Assistant =====

<WRAP round tip> Dans le Designer se trouve un [[:v8_0_0:designer:menus:accueil:start#ligne_de_commande|Assistant à la planification]]. Utilisez-le pour créer la structure de la commande, et enrichissez-la ensuite avec notre guide de syntaxe ci-dessous. </WRAP>

===== Utilisateur =====
<WRAP round tip>
Si on veut être sûr qu'il restera une connexion libre pour exécuter un travail planifié, il peut être utile de créer [[v8_0_0:admintool:menus:gestion:utilisateur:start#general|un utilisateur spécifique avec un profil de type "Vigilens Dedicated".]]
</WRAP>

===== Syntaxe =====

==== /vglForceInstall ====

  * Permet de saisir un nouveau répertoire partagé. cette option est commune à [[:v8_0_0:designer:start|Vigilens]] et à [[:v8_0_0:admintool:start|l'AdminTool]].

==== /vglExe=NomDeLaRequete ====

  * Exécution de la requête passée en paramètre
  * ne permet d’exécuter __que des requêtes partagées__.
  * //NomDeLaRequete//  représente le chemin relatif de la requête par rapport au répertoire partagé, tel qu’il apparaît dans **l’interface Vigilens**.
==== /vglAuto ====

  * Exécution automatique de toutes les requêtes présentes dans le répertoire saisi **__interactivement__** par l’utilisateur.
  * pour un process totalement automatique, utiliser /VglDir

==== /vglDir=NomDuDossier ====

  * Exécution automatique de toutes les requêtes présentes dans le répertoire passé en paramètre
  * //NomDuDossier//  représente le chemin complet du répertoire à traiter, tel qu’il apparaît dans un **explorateur de dossiers**  depuis la machine exécutant la ligne de commande.
==== /vglDirConf ====

  * Saisie du profil utilisé pour le traitement automatique (/vglDir)

<WRAP round important> À partir de Windows Vista (ou Server 2003), il est nécessaire d’exécuter cette commande en mode administrateur pour autoriser une exécution automatique par un planificateur de tâches. </WRAP>

==== /vglUser=NomUtilisateur ====

  * Utilisée en combinaison avec l’option /vglDir pour spécifier un utilisateur autre que l’utilisateur par défaut (sous réserve que ce dernier ait été renseigné par /vglDirConf)

==== /vglMail=AdresseMail ====

  * Utilisée en combinaison avec l’option /vglDir pour demander l’envoi par mail du résultat d’exécution (log).

==== /vglNumFormat=DecimalesMilliers ====

  * Les valeurs numériques restituées utiliseront :
      * le premier caractère précisé comme séparateur de décimales
      * le second précisé comme séparateur de milliers

==== /vglOutput=TypeSortie ====

  * Ce paramètre optionnel s’utilise avec le paramètre /vglExe.
  * Force un type de sortie autre que celui prévu au niveau de la requête.
  * Les valeurs possibles sont :
      * Grid : Ecran de restitution (défaut)
      * PDF : Fichier PDF
      * XLS : Fichier Excel
      * TXT : Fichier texte

==== /vglPDFType=TypeFichierPDF ====

  * Spécifie le type de sortie PDF.
  * Les valeurs possibles sont :
      * 0 Grille
      * 1 Etat
  * Ce paramètre est obligatoire avec le paramètre vglOutput=PDF .

==== /vglPDFModel=ModeleImpression ====

  * Spécifie le modèle d’état ou d’impression de la grille.
  * ce paramètre est obligatoire avec le paramètre vglOutput=PDF

==== /vglMaxLineNumber=Valeur ====

  * Spécifie le nombre maximum d’enregistrements à restituer.
  * Au-delà l’exécution de la requête s’arrête et renvoie un message d’erreur.
  * Ce paramètre permet de sécuriser l’emploi des ressources machine.

==== Passage de paramètres ====

  * Les valeurs des paramètres à l’exécution sont spécifiées dans la ligne de commande en utilisant leur code court
  * syntaxe : ''/CodeCourt=ValeurSelectionnee''
  * On peut ne pas les prendre en compte (autoriser toutes valeurs) par le caractère * en lieu et place de la valeur de sélection

===== Retour =====

L'application renvoie les codes de retour suivant :
  * 0     => Tout s'est bien passé
  * 10    => Connexion impossible
  * 100   => Echec de l'initialisation OLE
  * 1000  => Echec de l'initialisation des statistiques
  * 10000 => Problème de licence
  * 9999  => Erreur inconnue