Parameters in PARAM
= mandatory in PARAM
= mandatory in PARAM or in template worksheet
= mandatory in combination with another parameter, otherwise optional
= optional in PARAM
Parameters defined in the PARAM sheet are global parameters that apply to all data sources in the document.
This topic contains the following sections:
General Parameters
Below is a list of general parameters in PARAM: (select the parameter for more information)
|
Parameter (col A in PARAM) |
Mandatory/Optional |
Value in col C (example) |
Occurrence in PARAM sheet |
Comment |
|
|---|---|---|---|---|---|
|
FORM |
REPORT |
||||
|
|
|
TEMPLATE |
1 |
The parameter value needs to correspond to the actual template worksheet name. |
|
|
|
|
$CLIENT |
1 |
If $CLIENT, then value will be exchanged with logged in client. If a specific client is stated, then only that client can use the template. |
|
|
|
|
$USER |
1 |
If $USER, then value will be exchanged with logged in user. If a specific user is stated, then only that user can use the template. |
|
|
|
|
FORM/ REPORT/WEBLINK |
1 |
Defines the type of template (i.e. form, report, weblink). |
|
Common Parameters in PARAM
Below is a list of common parameters in PARAM: (select the parameter for more information)
|
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 |
|
|---|---|---|---|---|---|---|---|
|
FORM |
REPORT |
||||||
|
|
|
<OBJECT> |
N/A |
N/A |
1 |
Parameter in PARAM or in template in row 1. If SEARCHCOL object is the same for all rows in template, then use in PARAM. However, if objects are different for different rows then the parameter should be used in row 1. |
|
|
|
|
<OBJECT> |
N/A |
N/A |
1 |
Used if a new worksheet should be created for each specified object value (break report/forms). |
|
|
|
|
<object value(s)> |
<object value(s) Available from Bizview 2011 (1.0901.1427) |
N/A |
x number of times |
Define an object ID or any other data view field as parameter and object value(s) as parameter value. |
|
|
|
|
<procedure name> |
N/A |
N/A |
1
|
Instead of using the object values saved in Bizview to generate break values (new worksheets for each value selected), a procedure can be defined to create the break value data set. |
|
|
PUSH_SHEETS |
|
|
N/A |
N/A |
N/A |
1 |
Important: Not supported in v1 templates (new data engine). If ADDSHEET is used, this parameter can be used to show the first worksheet directly when generating the document, thereafter all other worksheets will be created in "silence". |
|
|
|
<DATASOURCE> |
<SQL query> or data view ID |
N/A |
x number of times |
Used in order to fetch additional information into the template (ADDINFO1, ADDINFO2, and so on). |
|
|
|
|
<Tag ID> |
<Description> |
TRUE/FALSE |
x number of times |
Parameter is used for hiding/showing columns and rows in the generated template. |
|
|
|
|
-0,001 |
N/A |
N/A |
1 |
If parameter or parameter value is missing, then the default value is 1. Value must be a valid number. Can be used in PARAM or in template. |
|
|
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
If parameter or parameter value is missing, then the default value is FALSE. If TRUE, then the document will be generated in debug mode. |
|
|
|
|
<data view ID> |
<Select Columns> |
<Order By Columns> |
1 |
Parameters to be used when generating dynamic columns. |
|
|
|
|
TRUE/FALSE |
TRUE/FALSE |
TRUE/FALSE |
1 |
Parameter to govern how a subtotal should be executed. |
|
|
Available from Bizview 2011 R3 (1.0404.1530)_03 |
|
|
<data view ID> |
Select Column |
Order By Column |
1 |
Instead of using standard code when expanding rowgroups, there is a possibility to define a customized data view that should be run when generating the expanded rowgroups. |
|
Available from Bizview 2011 R3 (1.0404.1530)_03 |
|
|
<procedure name> |
N/A |
N/A |
1 |
A procedure must be used if scanned TIFF-documents should be viewed from Bizview. One, or several, TIFF documents will be converted to one PDF document and streamed over to the client. |
|
Available from Bizview 2011 R3 (1.0404.1530)_04 |
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
Possibility to disable the "Save to Document Library" button in the end-user ribbon. A document containing this parameter will not be able to be saved in the library by the end-user. However, in a form containing the parameter, it will still be possible to update values to the database, but not save a work in progress form. |
|
INITIAL_SQL_ALL Available from Bizview 2013 (4.0.0) |
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
Important: Not supported in v1 templates (new data engine). From Bizview 2013, the way the initial SQL query for reports and forms is changed. Previously, the first SQL run for each generated document was a "Select * from..." without any group by. From this version, Bizview evaluates the columns needed in the template and then also adds a group by on these columns. By default, this parameter is set to FALSE; however, if the previous way of running the initial SQL query should be used, this parameter can be defined as TRUE. |
|
Available from Bizview 5.1 |
|
|
TRUE/FALSE |
N/A |
N/A |
max once for each section |
If a report or form should NOT consider any authorizations that are defined for user or organization, then this parameter can be defined in the template. In other words, if a user in a report should be able to view the result for the whole company, but only be able to view a specific unit when generating a budget form, then this parameter can be defined in the result report and the user will be able to view figures for all units for that particular report. |
|
Available from Bizview 8.1.4 & 8.3 |
|
|
<object ID> |
N/A |
N/A |
max once for each section |
If a report or form should NOT consider authorization rule on a specific object that are defined for user or organization, then this parameter can be defined in the template. |
|
Available from Bizview 6.1 |
|
|
<objversion ID> |
N/A |
N/A |
1 |
Possibility to define which object version a template should use when opened. |
|
Available from Bizview 7.0 |
|
|
0/1/2 (Auto, Right, Down)
|
N/A |
N/A |
1 |
Possibility to decide how the ENTER key should move in a specific template. Either Auto (to the right between only input cells in a FORM ), Right, or Down.
|
|
Available from Bizview 7.0 |
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
When Bizview 7.0 was released the SQL query mechanism was changed to make queries run faster. If the report or form does not work as it should then this parameter can be used in order to run the report/form the old way. |
|
USE_SAVED_OBJECTS Available in GUI from Bizview 7.1 |
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
Override the Bizview logic of retrieving parent values from any existing object tree. Bizview assumes that data is stored for the lowest level in an object tree and parent values are fetched from the object structures. |
|
Available from Bizview 7.1 |
|
|
cell reference or named range |
N/A |
N/A |
1 |
Possibility to define a specific cell that should be active when first opening the report or form. By default the active cell in for example forms is always the first entry cell that Bizview finds. However if the designer wants to override that logic this parameter can be set. |
|
Available from Bizview 7.2 |
|
|
button ID separated with # |
N/A |
N/A |
1 |
Possibility to hide unnecessary ribbon buttons for each template. The end-user ribbon for each template can now be altered. |
|
Available from Bizview 8.1 |
|
|
generation status |
update status |
N/A |
1 |
Events can be written to the report/form when generated. These events can then be used to conditionally format cells during generation. |
|
Available from Bizview 21.3.1 |
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
Important: Only applicable to v1 templates (new data engine). If this parameter is TRUE, forms and reports will create break sheets before data is fetched.
|
|
Available from Bizview 20.3 |
|
|
TRUE/FALSE |
N/A |
N/A |
1 |
Important: Only applicable to v1 templates (new data engine). If this parameter is TRUE, no automatic drill through will be possible to perform from the report or form. |
|
Available from Bizview 20.2 |
|
|
data view/data table column name (separated with # if several columns should be hidden) |
N/A |
N/A |
1 |
Important: Only applicable to v1 templates (new data engine). If this parameter exists and column names are defined in column C, then these specified columns will not be visible when performing a drill through in the report/form. |
FORM Specific Parameters in PARAM
Below is a list of FORM specific parameters in PARAM: (select the parameter for more information)
|
Parameter (col A in PARAM) |
Mandatory/Optional |
Value in col C (example) |
Value in col D (example) |
Value in col E (example) |
Value in col F (example) |
Occurrence in PARAM sheet |
Comment |
|
|---|---|---|---|---|---|---|---|---|
|
FORM |
REPORT |
|||||||
|
|
|
<VERSION ID> |
<VERSION ID> Available from Bizview 2011 (1.0901.1427) |
N/A |
N/A |
1 |
A valid version ID. |
|
|
|
|
<VALTYPE ID> |
<VALTYPE ID> Available from Bizview 2011 (1.0901.1427) |
N/A |
N/A |
1 |
A valid value type ID. Must be defined in PARAM or in template worksheet in row 1 or in column A. Can only be defined in one of these places. |
|
|
|
|
<CURRENCY ID> |
<CURRENCY ID> Available from Bizview 2011 (1.0901.1427) |
N/A |
N/A |
1 |
A valid currency ID. Must be defined in PARAM or in template worksheet in row 1 or in column A. Can only be defined in one of these places. |
|
|
|
N/A |
<OBJECT> |
<Object value> |
N/A |
N/A |
x number of times |
A where-clause for deleting existing records when updating data. Can be defined several times. |
|
|
|
N/A |
example |
N/A |
N/A |
N/A |
1 |
Define a default style for entry cells in the form (only applicable to cells that have not been formatted in the template). |
|
|
|
N/A |
example |
N/A |
N/A |
N/A |
1 |
Define a default style for no-entry cells in the form (only applicable to cells that have not been formatted in the template). |
|
|
|
N/A |
<view name> |
N/A |
N/A |
N/A |
1
|
Use an alternative source when fetching data from Bizview. Only applicable for fetching data, not updating. Caution: BV_SOURCE has been deprecated. |
|
|
|
N/A |
<TAG> |
<OBJECT> |
<Object value> |
Description for end-user Available from Bizview 2011 R2 (1.1215.1909) |
x number of times |
Define filters for the add row function. If the template contains several groups of accounts (for example), then a filter can be added to the group so that only accounts within the account group are shown when adding a row to that group. |
|
|
Available from Bizview 2011 R3 (1.0404.1530)_03 |
|
N/A |
TRUE/FALSE |
N/A |
N/A |
N/A |
1
|
Default value is FALSE. If set to TRUE, then the "Update Values" button in a form will automatically be activated when generating a form, even if no changes have manually been executed by the user. |
|
Available from Bizview 5.2 |
|
N/A |
TRUE/FALSE |
N/A |
N/A |
N/A |
1
|
Disable any defined spreadkey limits to specific objects in order to view all spreadkeys for the particular timevalues in the template. |
|
Available from Bizview 7.0 |
|
N/A |
<tag value> |
N/A |
N/A |
N/A |
1 |
Form specific parameter that should be used to tag each form with a value in order to avoid problems with different forms deleting values in another form. |
|
Available from Bizview 7.0 |
|
N/A |
TRUE/FALSE |
N/A |
N/A |
N/A |
1 |
Hide the allocation warning that occurs when opening a form and the spreadkey values have been changed since last update. |
|
Available from Bizview 7.0 |
|
N/A |
0/1/2/3 |
N/A |
N/A |
N/A |
1 |
Decide how Bizview should delete data when the user updates values from a form. |
|
Available from Bizview 7.0 |
|
N/A |
TRUE/FALSE |
N/A |
N/A |
N/A |
1
|
To override the default Bizview deletion method and decide exactly which dimensions should be included in the deletion (when values are updated in database). |
|
Available from Bizview 7.0.3 |
|
N/A |
TRUE/FALSE |
N/A |
N/A |
N/A |
1 |
Set spreadsheet to manual calculation (FALSE is default = automatic calculation). If set to TRUE, manual calculation will apply to spreadsheet and a new "Calculate Now" button will be created in ribbon |
|
|
N/A |
DATA TABLE ID |
N/A |
N/A |
N/A |
x number of times(depending on sections) |
The data table that the form should update values in the database. |
|
|
Available from Bizview v24.4 |
|
N/A |
TRUE/FALSE |
N/A |
N/A |
N/A |
1 |
Form-specific parameter that combines the save and refresh actions into a single action. When the Save Values button is clicked in a form and RELOAD_AFTER_SAVE parameter is set to TRUE, the form will automatically reload without requiring a manual refresh. Default value of parameter is False. |
REPORT Specific Parameters in PARAM
Below is a list of REPORT specific parameters in PARAM: (select the parameter for more information)
|
Parameter (col A in PARAM) |
Mandatory/Optional |
Value in col C (example) |
Occurrence in PARAM sheet |
Comment |
|
|---|---|---|---|---|---|
|
FORMS |
REPORT |
||||
|
N/A |
|
<worksheet name> |
1 |
If the ADDSHEET parameter is used, then this optional parameter can be used for REPORTS to create a total worksheet when break reports have been generated. |
|
|
Available from Bizview 2011 (1.0928.2019) |
N/A |
|
TRUE/FALSE |
1 |
Empty break sheets will be deleted and not shown. Only sheets with values will be visible for the end-user. Default is FALSE. Set this parameter to TRUE to override this and show empty break sheets. |
|
N/A |
|
TRUE/FALSE |
1 |
Default a group-by will be done for all columns with * in SOURCE. To override, this parameter must be defined in PARAM as FALSE. |
|
|
Available from Bizview 5.2 |
N/A |
|
CURR ID i.e. SEK |
1 | View the report in a specific currency. All values in the report will be recalculated to the selected currency. |
|
Available from Bizview 6.1 |
N/A |
|
TRUE/FALSE |
1 |
If ADDSHEET_TOTAL is used, then this parameter can be set to TRUE if the total sheet should be placed as first tab. If this parameter is not used, or set to FALSE, then the total sheet will be placed as last tab. |
|
Available from Bizview 23.2 |
N/A | ENABLED/DISABLED | 1 |
Enables drag and drop design. For new reports, the default value for this parameter is ENABLED'. To continue using the existing data binding functionality, set this parameter to DISABLED. |
|
LINK parameters in PARAM
Below is a list of LINK parameters in PARAM: (select the parameter for more information)
|
Parameter (col A in PARAM) |
Mandatory/Optional |
Value in col C (example) |
Value in col D (example) |
Value in col E (example) |
Value in col F (example) |
Value in col G (example) |
Value in col H (example) |
Occurrence in PARAM sheet |
Comment |
|
|---|---|---|---|---|---|---|---|---|---|---|
|
FORMS |
REPORT |
|||||||||
|
Available from Bizview 5.0 |
|
|
Template ID or web address |
<Button Text> |
<Button Image GUID> |
<Tooltip Text> |
<Tooltip Image GUID> |
TRUE/FALSE |
x number of times |
A link creates a button in the end-user ribbon that links to another template or web address. |
WEBLINK Specific Parameters in PARAM
Note: Only applicable for template type = WEBLINK. For example, integration to QlikView, Reporting Services, and Qlik Sense.
Below is a list of WEBLINK specific parameters in PARAM: (select the parameter for more information)
|
Parameter (col A in PARAM) |
Value in col C (example) |
Value in col D (example) |
Value in col E (example) |
Occurrence in PARAM sheet |
Comment |
|---|---|---|---|---|---|
|
Available from Bizview 5.0 |
URL |
; or , or any other URL separator |
TRUE/FALSE (open in new browser window or not) |
1 |
Specify the URL to the web address you want to navigate to. In this parameter only the "base" URL should be stated. Thereafter arguments (dynamic input parameters) is added using WEBLINK_ARG or QV_ARG to specify what should |
|
Available from Bizview 5.0 |
URL Argument ID |
<value> or $<controltag> from selection pane |
N/A |
x number of times |
Add any dynamic arguments that should be added to the base URL. WEBLINK_ARG is used for all type of integrations except QlikView, then QV_ARG is used. Which type that is used is governed by selecting "Other" or "QlikView" in the Argument type list. |
|
Available from Bizview 5.0 |
Property name in QlikView i.e LB01 |
<value> or $<controltag> from selection pane |
N/A |
x number of times |
Add any dynamic arguments that should be added to the base URL. QV_ARG is used for integration towards QlikView, all other integrations then WEBLINK_ARG is used. Which type that is used is governed by selecting "Other" or "QlikView" in the Argument type list. |
|
Available from Bizview 7.2 |
Property name in Qlik Sense i.e Region Name |
<value> or $<controltag> from selection pane |
N/A |
x number of times |
Add any dynamic arguments that should be added to the base URL. QVS_ARG is used for integration towards Qlik Sense. Which type that is used is governed by selecting "Other" , "QlikView" or "QLIKVIEW SENSE" in the Argument type list. |
DATASTORE Specific Parameters in PARAM (Not in use with new data engine)
Below is a list of DATASTORE specific parameters in PARAM: (select the parameter for more information)
|
Parameter (col A in PARAM) |
Value in col C (example) |
Occurrence in PARAM sheet |
Comment |
|---|---|---|---|
|
~LEDGERSUM Available from Bizview 5.2 |
TRUE/FALSE |
1 |
Summarize the ledger amounts. Default value is TRUE. |
|
~CONTRANS Available from Bizview 5.2 |
TRUE/FALSE |
1 |
Include consolidation transactions. |
|
~ELIMINATE Available from Bizview 5.2 |
TRUE/FALSE |
1 |
Eliminate inter-company transactions. |
|
~GETCHILD Available from Bizview 5.2 |
<obj:id>:<parent_attrib_id> UNIT:ORGPC |
1 |
Include child objects in the query. |
|
~SHOWCHILD Available from Bizview 6.1 |
TRUE/FALSE |
1 |
Show child objects in report. Should be used in combination with GETCHILD. |
|
~DETAIL_LOG Available from Bizview 5.2 |
TRUE/FALSE |
1 |
Activate detailed logging. |
|
~CURRPERIOD Available from Bizview 5.2 |
PERIOD i.e 201401 |
1 |
Period to use when calculating currency rates. Applicable to, for example, balance sheets when all values should be calculated with currency rates for one specific period. Only applicable to currency rates connected to a currency type with calculation method "Specific period rates". |
|
~EXEC_MODE Available from Bizview 5.2 |
TRANS_DATA |
1 |
Execution mode. |
|
~FINPLANDATA Available from Bizview 6.0 |
TRUE/FALSE |
1
|
Include financial planning data from Bizview. |
|
~ICFILTER Available from Bizview 6.0 |
<object value> |
1 |
Intercompany filter for elimination. |