ADDROW_FILTER
= 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) | Value in col F (example) | Occurrence in PARAM sheet | Comment | |
|---|---|---|---|---|---|---|---|---|
FORMS | REPORT | |||||||
ADDROW_FILTER |
| n/a | <STARTTAG> | <OBJECT>[<OBJECT>] Add [<OBJECT>] for returning column) | <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, for example accounts, then a filter can be added to the groups so that only accounts within the account group are shown when adding a row to that group. |
ADDROW_FILTER is an optional FORM specific parameter than can be used to filter the values that should be shown when adding a new row to a specific group in the template. If no ADDROW_FILTER is defined, then all new values will be visible in the 'Add New Row' dialog when inserting a new row. This parameter can be stated several times in column A in the PARAM worksheet.
The ADDROW_FILTER is defined together with #START and #STOP tags in the template worksheet. These start and stop tags define the different addrow filter groups, which you then need to specify in the ADDROW_FILTER parameter in PARAM. For each #START tag you have defined in the template worksheet in column A, you need to add a ADDROW_FILTER definition.
The values that are presented in the 'Add New Row' dialog in an opened form are always retrieved from corresponding GETTABLE data sheets. Before defining ADDROW filters, you should make sure that you have GETTABLE data sheets for the * columns in the template, and that those data sheets contain the data you want to filter the different addrow filters. The columns in the data sheets need to be <ObjectValueID> and Description. Thereafter, you can include any additional column that you want to base you filter on.
Access ADDROW_FILTER from the Template Design right panel by selecting Parameters > Filter Rows > Add Row Filters.
You can view the existing addrow filters defined in the PARAM sheet in the right panel grid. Here, you can also add new, edit existing, or delete addrow filters.
For each addrow filter, you should define the following:
- START tag: Either enter a new tag that you want to later add in the template worksheet, or click the tag icon to view the existing START tags already defined in the template worksheet. The START tag must be unique and only contain A-Z, a-z, 0-9, or underscore.
- Description: Add descriptive text describing each filter group, which will be shown in the Addrow Filter grid.
- Filter Column:Displays a list of all * columns specified in the template. Select which * column you want to filter the data shown in the Add New Row dialog for each addrow filter group.
Note: The column selected must also have a corresponding GETTABLE data sheet in the workbook. For example, if you select ITEM for the Filter Column, then you also need to create a GETTABLE data sheet with the sheetname ITEM, since it is the data sheet that Bizview reads to retrieve any new rows that could be added for the * column.
- Optional Filter Column: Only use this field if you want to filter the data on a column other than the Filter Column in the corresponding GETTABLE data sheet. For example, if you have an object structure that you want to utilize. The columns shown in the drop-down for this variable are the additional columns that exist in the selected Filter Column GETTABLE data sheet. For example, if you have selected ITEM as the Filter Column, then Bizview will read the ITEM data sheet and check if there are more than two columns. Any columns after the second column will be visible in this drop-down. If you would like to utilize the object structure between ITEMGRP and ITEM, make sure that your ITEM GETTABLE data sheet contains one additional column as the third column in the data sheet and the column contains the ITEMGRPs.
- Filter Value(s): If only a Filter Column has been selected, then the values entered in this field refer to object values for that column. The value(s) can be entered using SQL Smart Syntax to get the filter you want. If both a Filter Column and an Optional Filter Column have been selected, then the values entered in the Filter Value(s) field refers to object values for the Optional Filter Column. Upon selecting the tag icon, you can select and view the $ variables supported when defining the filter values that should be applied. For example, using $BREAK in combination with another criteria, like $BREAK(ITEM:3%). In this example, the break object needs to be an additional column in the GETTABLE data sheet in order to get the related ITEM values for each break sheet.
- For example:
- If you selected 'ITEM' as the Filter Column and no Optional Filter Column, and entered values '101..199' in the Filter Value(s) field, that particular addrow filter will filter out ITEMs between 101 and 199.
- If you selected 'ITEM' as the Filter Column and 'ITEMGRP' as the Optional Filter column, and entered value '102' in the Filter Value(s) field, that particular addrow filter will filter out ITEMGRP with value 102 and show all missing ITEMs linked to ITEMGRP 102 in the 'Add New Row' dialog.
- If you selected 'ITEM' as the Filter Column and 'UNIT' (the break Object) as the Optional Filter column, and entered value '$BREAK(ITEM:3%)', that particular addrow filter will check in which break sheet you are when adding the new row, filter out that UNIT value for the break sheet in the GETTABLE ACCOUNT data sheet, and show all linked missing ITEMs to the UNIT break value in the 'Add New Row' dialog.
- For example:
The example below shows how the GETTABLE sheet looks if you are using an Optional Filter Column:
