You can use several optional parameters in your Template in order to realize specific functions. Please remember that all named ranges in data1.io must be defined on a sheet (and not workbook) level.
The following optional parameters can be defined:
- data1_CELLS01_SysDELTA (see here for more details)
- data1_CELLS01_ExceptionType0 usw. (see here for more details)
- data1_CELLS01_DIMxxx_Level / data1_CELLS01_DATExx_Level (see here for more details)
- data1_CELLS01_DIMxxx_Key
- data1_CELLS01_DIMxxx_Attribute
- data1_CELLS01_IsSumLevel
- data1_CELLS01_SyncSheets_Read
- data1_CELLS01_SyncSheets_Write
- data1_CurrentUserKey
- data1_CurrentSheetVisible
- data1_CELLS01_TriggerReadOnChange
- data1_CELLS01_TriggerTreeSelectionAndReadOnChange(_x)
- data1_ReadFirstBottomElement
- data1_CELLS01_InsertTable_T_DIMxxx
- data1_CELLS01_InsertTable_T_DIMxxx_Filter
- data1_CELLS01_ChangedCellFormat
data1_CELLS01_DIMxxx_Key
You can use this optional parameter to get the Key of the currently selected element in the dimension tree (addtionally to the obligatory name of the element).
data1_CELLS01_DIMxxx_Attribute
You can use this optional parameter to the name of the field ("level") of the currently selected element in the dimension tree. Primary, this is used as part of a filter condition for a dynamic filter table.
data1_CELLS01_IsSumLevel
This is very simple: double clicking an element in the dimension tree will deliver a "0" or a "1":
- 0 = Sum Level
- 1 = Bottom Level
You can use this parameter for a level-specific configuration of the R/W control panel in order to realize advanced aggregation effects.
data1_CELLS01_SyncSheets_Read
Use this parameter to (optinally) sync the READ process for several sheets in your Template file. Simply enter the number of the sheets that should be part of the READ process and seperate them with a comma and space. Please note that you must also add the number of the current sheet if you want to keep the "normal" read behaviour for this sheet. We recommend to use the Excel function SHEET() in order to set the definitions dynamically.
Look at this example: the Excel Template file has 3 sheets. The first two sheets must always be read (and written) together since sheet 1 contains the parameters for the calculations in sheet 2. Simply add the named range with the content "1, 2" in the main sheet ...
... as well as in the Parameter sheet:
data1_CELLS01_SyncSheets_Write
Use this parameter to (optionally) sync the WRITE process for several sheets in your Template file. Works like the data1_CELLS01_SyncSheets_Read.
Please note that there is an addtional mechanism for the <SYSTEM Delta> Parameter: if you use in all sheets the same <SYSTEM Delta> Parameter then the delete process will be executed only once before writing the first sheet back (and not before every sheet). Nevertheless we recommend to use different <SYSTEM Delta> Parameters in every sheet since this is more intuitive.
data1_CurrentUserKey
Delivers the e-mail adress of the currently logged in user. Can be used to setup a user specific security within the workbook.
data1_CurrentSheetVisible
1 = current sheet is visible
0 = current sheet is not visible
Can be used to setup a dynamic worksheet structure within the workbook depending on the currently logged in user ("object level security") and/or the currently selected element in the dimension tree.
data1_CELLS01_TriggerReadOnChange
Any change in a cell in this name range will cause a read process. Can be used for dropdowns in your workbook to trigger a refresh.
data1_CELLS01_TriggerTreeSelectionAndReadOnChange(_x)
With this named range you can select a dimension tree key in the dropdown, pass it to the tree and then trigger the read process (= refresh).
More exactly, you can define a variable number of named ranges starting with data1_CELLS01_TriggerTreeSelectionAndReadOnChange, all of them will trigger the described process.
data1_ReadFirstBottomElement
0 = the predefined element (from the workbook) will be read on opening the workbook
1 = the first bottom element (from the tree) will be read on opening the workbook
Can be used to jump directly to the first bottom element in order to start immediately with data entry.