====== Création d'URL vers Vigilens ======

Une des grandes forces de Vigilens Reporting est la possibilité d'appeler, à partir d'un logiciel tiers ou d'un simple navigateur, un rapport. Voici le détail de la syntaxe.

<WRAP round important>
Pour accéder à cette fonctionnalité, il faut disposer de [[v8_0_0:web:start|Vigilens Web]].
</WRAP>
 
===== Syntaxe générale =====
''http://NomServeur/chemin/table.php?vglCtrlName=NomRequete&parametre1=valeur1&parametre2=valeur2''
===== Assitant =====

<WRAP round tip>
Dans le [[v8_0_0:designer:start|Designer]], il y a un [[v8_0_0:designer:menus:accueil:start#ligne_de_commande|assistant Ligne de commande]] qui vous permet de construire automatiquement une url de base, que pourrez adapter à vos besoins.
</WRAP>

===== Paramètres =====

<WRAP round info>
  * Les valeurs des paramètres à l’exécution sont spécifiées dans l’url en utilisant leur code court
    * syntaxe : ''&CodeCourt="//ValeurSelectionnee//"''.
  * On peut ne pas utiliser le "by-pass" (caractère jocker "*") pour paramètres utilisé comme [[v8_0_0:designer:menus:accueil:nouvellerequete:criteres|critères]]
</WRAP>

==== vglCtrlName=NomDeLaRequete ====
  * Spécifie le nom de la requête à exécuter.
  * Ce paramètre est obligatoire.
  * "//NomDeLaRequete//" représente le chemin relatif de la requête par rapport au répertoire partagé (chemin tel qu’il apparaît dans l’interface Vigilens).

<WRAP round important>
  * Le paramètre vglCtrlName ne permet d’exécuter que des requêtes partagées.
</WRAP>
=== Exemples ===
  * ''table.php?vglCtrlName=Test'' => Lance la requête « Test » présente directement sous le répertoire partagé.
  * ''table.php?vglCtrlName=SsRep\Test'' => Lance la requête « Test » présente sous le sousrépertoire « SsRep » du répertoire partagé.
==== vglUserName=NomUtilisateur ====
  * Spécifie l’utilisateur et n’affiche pas de fenêtre de connexion s’il est reconnu.
  * Ce paramètre est optionnel.
==== vglOutput=TypeSortie ====
  * 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)
    * XMLTable Page XML (tableau)
    * XLTable Page XML incorporable sous Excel (appel de la requête depuis Excel uniquement)
    * PDF Fichier PDF
    * XLS Fichier Excel
    * TXT Fichier texte
  * Ce paramètre est optionnel
==== vglHeader=FormatEntête ====
  * Spécifie l’entête des colonnes du type de sortie XMLTable et XLTable.
  * Les valeurs possibles sont :
    * 0 Aucune information
    * 1 Nom (défaut)
    * 2 Description
    * 3 Nom et Description
==== vglPDFType=TypeFichierPDF ====
  * Spécifie le type de sortie PDF.
  * Les valeurs possibles sont :
    * 0 Grille
    * 1 Etat
    * 2 Grille avec archivage
    * 3 Etat avec archivage
  * 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.
==== 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
  * Ce paramètre est optionnel.
==== vglArchive=1 ====
  * Dans le cas d’une restitution sous forme de fichier, ce paramètre force l’archivage du fichier (quelle que soit la valeur du paramètre vglPDFType) sur le serveur web.
  * Ce paramètre est optionnel.
==== vglQueryEnv=Environnement ====
  * Cette commande permet de piloter l'environnement JDE d'exécution de la requête (cf [[v8_0_0:admintool:menus:accueil:envtodb:start|configuration base de données/ environnement]] avec l'AdminTools).
  * Ce paramètre est optionnel.