meta data for this page

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 creates 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 a wildcard (“*”) for a parameter used as criteria

vglCtrlName=QueryName

  • Specifies the name of the query to execute.
  • This parameter is mandatory.
  • “QueryName” represents the relative path of the query in 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=HeaderFormat

  • Specifies the column headers of the XMLTable and XLTable output type.
  • Possible values are :
    • 0 No information
    • 1 Name (default)
    • 2 Description
    • 3 Name and Description

vglPDFType=PDFFileType

  • Specifies the type of PDF output.
  • Possible values are :
    • 0 Grid
    • 1 State
    • 2 Grid with archiving
    • 3 Report with archiving
  • This parameter is mandatory with parameter vglOutput=PDF.

vglPDFModel=PrintTemplate

  • Specifies the report or print template of the grid.
  • This parameter is mandatory with parameter vglOutput=PDF.

vglNumFormat=DecimalsThousands

  • The numerical values returned will use
    • the first character specified as decimal separator
    • the second one as the thousands separator
  • This parameter is optional.

vglArchive=1

  • In the case of a file output, this parameter forces the file (regardless of the value of the vglPDFType parameter) to be archived on the web server.
  • This parameter is optional.

vglQueryEnv=Environment