Skip to content

Export Tree

Exports a tree to a text file. The text file is saved on the server.

Permissions

Command KindNeeded User Kind
ReadAll

Parameters

NameTypeDescriptionRequiredDefaultValues
DimensionstringName of the dimension ([Dimension]).yes
FilestringName/path of the export file. The file is exported on the server.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
AttributebooleanIf 'True' attributes are exported. The default value is 'True'.notrue
BracketsbooleanIf 'True' the dimension items are exported with brackets ([Item]). The default value is 'True'.notrue
BuilderbooleanIf 'True' the builder function for sums is exported. The default value is 'True'.notrue
BuilderSortbooleanIf 'True' the builder sort order for sums is exported. The default value is 'True'.notrue
Caption1booleanIf 'True' caption 1 is exported. The default value is 'True'.notrue
Caption2booleanIf 'True' caption 2 is exported. The default value is 'True'.notrue
Caption3booleanIf 'True' caption 3 is exported. The default value is 'True'.notrue
Caption4booleanIf 'True' caption 4 is exported. The default value is 'True'.notrue
Caption5booleanIf 'True' caption 5 is exported. The default value is 'True'.notrue
Caption6booleanIf 'True' caption 6 is exported. The default value is 'True'.notrue
Caption7booleanIf 'True' caption 7 is exported. The default value is 'True'.notrue
Caption8booleanIf 'True' caption 8 is exported. The default value is 'True'.notrue
Caption9booleanIf 'True' caption 9 is exported. The default value is 'True'.notrue
Caption10booleanIf 'True' caption 10 is exported. The default value is 'True'.notrue
CodingstringCoding of the file: Ansi, Ascii, BigEndianUnicode, Unicode (Utf16/Utf-16), Utf7 (Utf-7) or Utf8 (Utf-8). The default value is Utf8.noUtf8Ansi, Ascii, BigEndianUnicode, Unicode, Utf7, Utf8
DecimalSeparatorstringDecimal separator (long and short): Comma (,) or Point (.). The default value is Point (.)noPointComma, Point
FactorbooleanIf 'True' the factor is exported. The default value is 'True'.notrue
FieldSeparatorstringField separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|).noTabulatorCircumflex, Comma, Semicolon, Tabulator, Pipe
HeaderbooleanIf 'True' the header is exported. The default value is 'True'.notrue
InvisiblebooleanIf 'True' invisible is exported. The default value is 'True'.notrue
KpibooleanIf 'True' the KPI function for sums is exported. The default value is 'True'.notrue
MaxRecordsintegerMaximum number of records to be exported. The default value is 500000.no500000
QuotedbooleanIf 'True' the text fields are quoted ("Text"). The default value is 'False'.nofalse
TopstringParent text for the top level items and sums. The default value is '<Top>'.no<Top>

Result

No fields

Code

text
EXPORT TREE
DIMENSION=[string, Needed]
FILE=[string, Needed]
TREE=[string, Needed]
ATTRIBUTE=[boolean, default=true]
BRACKETS=[boolean, default=true]
BUILDER=[boolean, default=true]
BUILDERSORT=[boolean, default=true]
CAPTION1=[boolean, default=true]
CAPTION2=[boolean, default=true]
CAPTION3=[boolean, default=true]
CAPTION4=[boolean, default=true]
CAPTION5=[boolean, default=true]
CAPTION6=[boolean, default=true]
CAPTION7=[boolean, default=true]
CAPTION8=[boolean, default=true]
CAPTION9=[boolean, default=true]
CAPTION10=[boolean, default=true]
CODING=[string, default=Utf8, values=[Ansi,Ascii,BigEndianUnicode,Unicode,Utf7,Utf8]]
DECIMALSEPARATOR=[string, default=Point, values=[Comma,Point]]
FACTOR=[boolean, default=true]
FIELDSEPARATOR=[string, default=Tabulator, values=[Circumflex,Comma,Semicolon,Tabulator,Pipe]]
HEADER=[boolean, default=true]
INVISIBLE=[boolean, default=true]
KPI=[boolean, default=true]
MAXRECORDS=[integer, default=500000]
QUOTED=[boolean, default=false]
TOP=[string, default=&lt;Top&gt;]