meta data for this page
  •  

This is an old revision of the document!

Create URL to access Vigilens

One of the great strengths of Vigilens Reporting is the possibility to call up a report from a third party software or a simple browser. Here is the detail of the syntax.

To access this feature, you must have Vigilens Web.

General syntax

http://ServerName/Path/table.php?vglCtrlName=QueryName&parameter1=value1&parameter2=value2

Wizard

In Designer, there is a #TBC command line wizard that create a basic URL for you. Improve this URL to fit your needs.

Parameters

  • Runtime parameters are passed using their shortcode.
    • syntax : &ShorCode=“SelectedValue”.
  • You cannot use wildcard (“*”) for a parameter used as criteria

vglCtrlName=QueryName

  • Specifies the name of the query to execute.
  • This parameter is mandatory.
  • “QueryName” it represents the relative path of the request in relation to the shared directory (path as it appears in the Vigilens interface).
  • The vglCtrlName parameter allows executing only shared queries.

Exemples

  • table.php?vglCtrlName=Test ⇒ Launches the “Test” query directly under the shared directory..
  • table.php?vglCtrlName=SubDir\Test ⇒ Launches the “Test” query in the “SubDir” subdirectory of the shared directory.

vglUserName=UserName

  • Specifies the user and does not display a login window if recognized.
  • This setting is optional.

vglOutput=OutputType

  • Force an output type other than the one provided in the query.
  • Possible values are :
    • Grid : Interactive Grid (default)
    • XMLTable : XML Page (table)
    • XLTable : Embeddable XML page in Excel (query call from Excel only)
    • PDF
    • XLS : Excel file
    • TXT : text file
  • This setting is optional.

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.