TRACE
- Short Commands to Trigger TRACE (generate document)
- Short Command to Trigger TRACE (update form)
- Tracing #plandata
= optional in PARAM sheet
Parameter (col A in PARAM) | Mandatory/Optional | Value in col C (example) | Value in col D (example) | Value in col E (example) | Occurrence in PARAM sheet | Comment | |
|---|---|---|---|---|---|---|---|
FORMS | REPORT | ||||||
TRACE | TRUE/FALSE | N/A | N/A | 1 | If parameter or parameter value is missing, then default value is FALSE. If TRUE then the document will be generated in debug mode. | ||
TRACE is a common parameter which can be used as a tool for the template designer and/or for troubleshooting purposes. The parameter should be used for troubleshooting purposes to activate tracing of the SQL-queries created when generating the document. In addition, if the parameter is set as TRUE, then all worksheets in the document (including the hidden worksheets PARAM, PANE sheet etc.), as well as the design area of the template will be visible.
If parameter is TRUE:
All hidden worksheets, such as PARAM and PANE, will be visible after generating the document.
The design area of the template will be visible after generating the document (column A and row 1).
Trace of all SQL-queries towards the database. New trace tables will be created in the database. These tables are unique for each user generating the document.
Access TRACE in Template Design by selecting the PARAM tab of the worksheet:
The TRACE parameter displays in the Common parameters (FORM/REPORT) section of the PARAMETER SHEET, shown below:
In the example above, TRACE is set to FALSE (default value). When generating a document with TRACE set as TRUE, then all worksheets will be visible, as well as the design area of the template. In addition, a new table in the Bizview database will be created where all the run SQL queries can be viewed.
In the database, a new table has been created (or updated if it already existed), like below. The table name will be trc.trc_<user_id>_trace_rows. In this table all run SQL queries can be viewed. To troubleshoot and trace these SQL queries, then copy the queries from the column SQL and paste in a new query window.