meta data for this page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:v8_0_0:howto:url [2020/07/08 10:33] sylvainair [vglPDFType=TypeFichierPDF] |
en:v8_0_0:howto:url [2021/02/01 11:33] (current) sylvainair [vglArchive=1] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Create URL to access Vigilens ====== | ====== 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. | 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. | ||
| Line 14: | Line 12: | ||
| <WRAP round tip> | <WRAP round tip> | ||
| - | In [[:en:v8_0_0:designer:start|Designer]], there is a #TBC [[:en:v8_0_0:designer:menus:accueil:start#command_line|command line wizard]] that create a basic URL for you. Improve this URL to fit your needs. | + | In [[:en:v8_0_0:designer:start|Designer]], there is a #TBC [[:en:v8_0_0:designer:menus:accueil:start#command_line|command line wizard]] that creates a basic URL for you. Improve this URL to fit your needs. |
| </WRAP> | </WRAP> | ||
| Line 22: | Line 20: | ||
| * Runtime parameters are passed using their shortcode. | * Runtime parameters are passed using their shortcode. | ||
| * syntax : ''&ShorCode="//SelectedValue//"''. | * syntax : ''&ShorCode="//SelectedValue//"''. | ||
| - | * You cannot use wildcard ("*") for a parameter used as [[v8_0_0:designer:menus:accueil:nouvellerequete:criteres|criteria]] | + | * You cannot use a wildcard ("*") for a parameter used as [[:en:v8_0_0:designer:menus:accueil:nouvellerequete:criteres|criteria]] |
| </WRAP> | </WRAP> | ||
| Line 28: | Line 26: | ||
| * Specifies the name of the query to execute. | * Specifies the name of the query to execute. | ||
| * This parameter is mandatory. | * 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). | + | * "//QueryName//" represents the relative path of the query in the shared directory (path as it appears in the Vigilens interface). |
| <WRAP round important> | <WRAP round important> | ||
| Line 34: | Line 32: | ||
| </WRAP> | </WRAP> | ||
| === Exemples === | === Exemples === | ||
| - | * ''table.php?vglCtrlName=Test'' => Launches the "Test" query directly under the shared directory.. | + | * ''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. | * ''table.php?vglCtrlName=SubDir\Test'' => Launches the "Test" query in the "SubDir" subdirectory of the shared directory. | ||
| ==== vglUserName=UserName ==== | ==== vglUserName=UserName ==== | ||
| Line 42: | Line 40: | ||
| * Force an output type other than the one provided in the query. | * Force an output type other than the one provided in the query. | ||
| * Possible values are : | * Possible values are : | ||
| - | * Grid : Interactive Grid (default) | + | * Grid: Interactive Grid (default) |
| - | * XMLTable : XML Page (table) | + | * XMLTable: XML Page (table) |
| - | * XLTable : Embeddable XML page in Excel (query call from Excel only) | + | * XLTable: Embeddable XML page in Excel (query call from Excel only) |
| - | * XLS : Excel file | + | * XLS: Excel file |
| - | * TXT : text file | + | * TXT: text file |
| * This setting is optional. | * This setting is optional. | ||
| ==== vglHeader=HeaderFormat ==== | ==== vglHeader=HeaderFormat ==== | ||
| Line 64: | Line 62: | ||
| * 3 Report with archiving | * 3 Report with archiving | ||
| * This parameter is mandatory with parameter vglOutput=PDF. | * This parameter is mandatory with parameter vglOutput=PDF. | ||
| - | ==== vglPDFModel=ModeleImpression ==== | + | ==== vglPDFModel=PrintTemplate ==== |
| - | * Spécifie le modèle d’état ou d’impression de la grille. | + | * Specifies the report or print template of the grid. |
| - | * Ce paramètre est obligatoire avec le paramètre vglOutput=PDF. | + | * This parameter is mandatory with parameter vglOutput=PDF. |
| - | ==== vglNumFormat=DecimalesMilliers ==== | + | ==== vglNumFormat=DecimalsThousands ==== |
| - | * Les valeurs numériques restituées utiliseront | + | * The numerical values returned will use |
| - | * le premier caractère précisé comme séparateur de décimales | + | * the first character specified as decimal separator |
| - | * le second précisé comme séparateur de milliers | + | * the second one as the thousands separator |
| - | * Ce paramètre est optionnel. | + | * This parameter is optional. |
| ==== vglArchive=1 ==== | ==== 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. | + | * 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. |
| - | * Ce paramètre est optionnel. | + | * This parameter is optional. |
| + | ==== vglQueryEnv=Environment ==== | ||
| + | * This command allows you to control the JDE environment for the execution of the query (see [[:en:v8_0_0:admintool:menus:accueil:envtodb:start|database / environment configuration]] with AdminTools). | ||
| + | * This parameter is optional. | ||