ADDSHEET_PROC
Feature available from Bizview version - Bizview 2011 (1.0630.1705)
= optional PARAM sheet
Parameter (col A in PARAM) | Mandatory/Optional | Value in col C | Value in col D | Value in col E (example) | Occurrence in PARAM sheet | Comment | |
---|---|---|---|---|---|---|---|
FORM | REPORT | ||||||
ADSHEET_PROC | <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. |
ADDSHEET_PROC is a common, optional, parameter that can be used both for FORMS and REPORTS. By default, the break values to create worksheets in a document are created from the data result Bizview receives when opening the report or form. As a result, you can select any column that exists in a data source used in the template and break on. Sometimes, however, if the designers do not want to use the default behavior in Bizview when creating break sheets, then this parameter can be defined. This parameter states a procedure that should create a break value data set.
Note: The procedure must return a data table with two columns (one id column and one description column). In order for this parameter to work in v1 templates (new data engine), parameter PRE_GENERATE_BREAK needs to be set to TRUE.
Procedure parameters (receiving parameter):
- @client_id
- @user_id
- @column
- @value
Procedure example:
Access ADSHEET_PROC in the Template Design right panel by selecting Parameters > Worksheets > Addsheet Procedure.
In the Addsheet Procedure field, you can either enter the procedure name directly or click the icon to the right to access a drop-down with procedures saved in the Bizview database in the cust. schema. Only procedures with four input variables display in the list, since that is what the ADDSHEET_PROC parameter requires.