Skip to content

Export Dimension

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

Permissions

Command KindNeeded User Kind
ReadAdmin, Sys

Parameters

NameTypeDescriptionRequiredDefaultValues
FilestringName/path of the export file. The file is exported on the server.yes
DimensionstringName of the dimension ([Dimension]).yes
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
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
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
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
StartRecordintegerRecord number where the export should start. The default value is '0', which means no start record. This is useful when a large number of records should be exported in multiple parts.no0

Result

No fields

Code

text
EXPORT DIMENSION
FILE=[string, Needed]
DIMENSION=[string, Needed]
ATTRIBUTE=[boolean, default=true]
BRACKETS=[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]]
FIELDSEPARATOR=[string, default=Tabulator, values=[Circumflex,Comma,Semicolon,Tabulator,Pipe]]
HEADER=[boolean, default=true]
MAXRECORDS=[integer, default=500000]
QUOTED=[boolean, default=false]
STARTRECORD=[integer, default=0]