Appearance
Set Subtree Items
Sets the items of a subtree.
Permissions
| Command Kind | Needed User Kind |
|---|---|
| Write | All |
Parameters
| Name | Type | Description | Required | Default | Values |
|---|---|---|---|---|---|
| Dimension | string | Name of the dimension ([Dimension]). | yes | ||
| Subtree | string | Name of the subtree ([Subtree]). A subtree is a flat extract of items and sums of the tree. | yes | ||
| Tree | string | Name 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 dimension | yes | ||
| Adjust | boolean | If 'True' protected command chars are replaced: '[' becomes '(', ']' becomes ')' and '=' becomes empty. The default value is 'True'. | no | true | |
| Create | boolean | If 'True' a non existing subtree will be created. The default value is 'False'. | no | false | |
| EditItems | boolean | The item can include captions and attributes. If 'True', the captions and attributes are used to change the dimension items. The default value is 'False'. | no | false | |
| EditSums | boolean | The sum can include captions. If 'True', the captions are used to update the captions of corresponding sum elements in the tree. The default value is 'False'. | no | false | |
| FieldSeparator | string | Field separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|). The default separator is Tab. | no | ||
| IgnoreErrors | boolean | If 'True' errors are ignored. If 'False' the command is stopped and an error message is displayed. The default value is 'False'. | no | false | |
| Item | array of string | Item with name, captions and attribute. Normally only name is used. The captions and attribute can be used to edit the dimension item. The fields are separated by the 'FieldSeparator' char. A semicolon can be used ([Item];[Caption1];[Caption2];[Caption3];[Caption4];[Caption5];[Caption6];[Caption7];[Caption8];[Caption9];[Caption10];[Attribute]), e.g. [1234];[Product 1234];[];[];[];[];[];[];[];[];[];[Size].[L],[Color].[Blue] | no | ||
| Sum | array of string | Sum with name and captions. Normally only name is used. The captions can be used to edit the tree sum. The fields are separated by the 'FieldSeparator' char. A semicolon can be used ([Item];[Caption1];[Caption2];[Caption3];[Caption4];[Caption5];[Caption6];[Caption7];[Caption8];[Caption9];[Caption10]), e.g. [Europe];[Export to Europe];[];[];[];[];[];[];[];[];[] | no |
Result
No fields
Code
text
SET SUBTREE ITEMS
DIMENSION=[string, Needed]
SUBTREE=[string, Needed]
TREE=[string, Needed]
ADJUST=[boolean, default=true]
CREATE=[boolean, default=false]
EDITITEMS=[boolean, default=false]
EDITSUMS=[boolean, default=false]
FIELDSEPARATOR=[string]
IGNOREERRORS=[boolean, default=false]
ITEM=[string, Multiple]
SUM=[string, Multiple]