Skip to content

Set Formula Items

Sets the items and sums of a formula.

Permissions

Command KindNeeded User Kind
WriteAll

Parameters

NameTypeDescriptionRequiredDefaultValues
DimensionstringName of the dimension ([Dimension]).yes
FormulastringName of the formula ([Formula]). A formula is a flat structure of a dimension. A Formula is build of items and sums. Sums are calculated with functions.yes
AdjustbooleanIf 'True' protected command chars are replaced: '[' becomes '(', ']' becomes ')' and '=' becomes empty. The default value is 'True'.notrue
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 change the dimension items. The default value is 'False'.nofalse
FieldSeparatorstringField separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|).noTabulatorCircumflex, Comma, Semicolon, Tabulator, Pipe
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 name, factor, captions, attribute, rubric, factor and invisible. 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];[Rubric];[Factor];[Invisible]), e.g. [1234];[Product 1234];[];[];[];[];[];[];[];[];[];[Size].[L],[Color].[Blue];[Product];[1];[False]no
Sumarray of stringSum with name, factor, captions, attribute, rubric, factor, invisible and input. The fields are separated by the 'FieldSeparator' char. A semicolon can be used ([Sum];[Caption1];[Caption2];[Caption3];[Caption4];[Caption5];[Caption6];[Caption7];[Caption8];[Caption9];[Caption10];[Attribute];[Rubric];[Factor];[Invisible];Input), e.g. [Costs];[Costs Total];[];[];[];[];[];[];[];[];[];[Size].[L],[Color].[Blue];[Product];[1];[False];SumRange("Cost 1","Cost 10")no

Result

No fields

Code

text
SET FORMULA ITEMS
DIMENSION=[string, Needed]
FORMULA=[string, Needed]
ADJUST=[boolean, default=true]
CREATEITEMS=[boolean, default=false]
EDITITEMS=[boolean, default=false]
FIELDSEPARATOR=[string, default=Tabulator, values=[Circumflex,Comma,Semicolon,Tabulator,Pipe]]
IGNOREERRORS=[boolean, default=false]
ITEM=[string, Multiple]
SUM=[string, Multiple]