Skip to content

Set Tree Items

Sets the items of a tree.

Permissions

Command KindNeeded User Kind
WriteAll

Parameters

NameTypeDescriptionRequiredDefaultValues
DimensionstringName of the dimension ([Dimension]).yes
TreestringName of the tree ([Tree]). A tree is a hierarchical structure of a dimension. A tree is build of sums. These sums can contain other sums or elements of the dimensionyes
AdjustbooleanIf 'True' protected command chars are replaced: '[' becomes '(', ']' becomes ')' and '=' becomes empty. The default value is 'True'.notrue
CreatebooleanIf 'True' a non existing tree will be created. The default value is 'False'.nofalse
CreateItemsbooleanIf 'True' a non existing item will be created. The default value is 'False'.nofalse
EditItemsbooleanThe item can include captions and attributes. If 'True', the captions and attributes are used to update captions and attributes of the corresponding dimension items. The default value is 'False'.nofalse
FieldSeparatorstringField separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|). The default separator is Tab.no
IgnoreErrorsbooleanIf 'True' errors are ignored. If 'False' the command is stopped and an error message is displayed. The default value is 'False'.nofalse
Itemarray of stringItem with parent, name, captions, attribute, factor, invisible, KPI, builder function and builder sort. The fields are separated by the 'FieldSeparator' char. A semicolon can be used ([Parent];[Item];[Caption1];[Caption2];[Caption3];[Caption4];[Caption5];[Caption6];[Caption7];[Caption8];[Caption9];[Caption10];[Attribute]), e.g. [Profit];[1234];[Product 1234];[];[];[];[];[];[];[];[];[];[Size].[L],[Color].[Blue];[1];[False];;;no
Sumarray of stringSum with parent, name, factor, captions, attribute, factor, invisible, KPI, builder function and builder sort. The fields are separated by the 'FieldSeparator' char. A semicolon can be used ([Parent];[Item];[Caption1];[Caption2];[Caption3];[Caption4];[Caption5];[Caption6];[Caption7];[Caption8];[Caption9];[Caption10];[Attribute]),e.g. [<Top>];[Profit];[Profit Total];[];[];[];[];[];[];[];[];[];;;[1];[False];[Personnel Costs],[Material Costs],[Marketing costs].[%].[Turnover];StrStarts("Cost_",Name());[Caption1]no
TopstringParent text for the top level items and sums. The default value is '<Top>'.no<Top>

Result

No fields

Code

text
SET TREE ITEMS
DIMENSION=[string, Needed]
TREE=[string, Needed]
ADJUST=[boolean, default=true]
CREATE=[boolean, default=false]
CREATEITEMS=[boolean, default=false]
EDITITEMS=[boolean, default=false]
FIELDSEPARATOR=[string]
IGNOREERRORS=[boolean, default=false]
ITEM=[string, Multiple]
SUM=[string, Multiple]
TOP=[string, default=&lt;Top&gt;]