Skip to content

Export Table

Exports a table 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
TablestringName of the table ([Table]).yes
BracketsbooleanIf 'True' the dimension items are exported with brackets ([Item]). 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
DayFormatstringDay format examples: YYYY-MM-DD, MM/DD/YYYY, MM-DD-YYYY, DD.MM.YYYY.no
DecimalSeparatorstringDecimal separator (long and short): Comma (,) or Point (.). The default value is Point (.)noPointComma, Point
Fieldarray of stringField to be exported (number or text). If no field is specified, all fields are exported.no
FieldSeparatorstringField separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|).noTabulatorCircumflex, Comma, Semicolon, Tabulator, Pipe
Filterarray of stringFilters by dimension item ([Dimension].[Item]) or tree sum ([Dimension].[Tree].[Sum]). The tree sum format is equal to 'FilterTree'.no
FilterAttributearray of stringFilters by attribute ([Dimension].[Attribute].[Value]).no
FilterFieldarray of stringFilters by field ([Field].[Operator].[Value]). The operators are (long and short): Contains (CO), Ends (EN), Equal (EQ), Greater (GR), GreaterEqual (GE), Less (LS), LessEqual (LE), NotContains (NC), Starts (ST) and Unequal/NotEqual (UE/NE)no
FilterRangearray of stringFilters by an item range ([Dimension].[StartItem].[EndItem]).no
FilterTreearray of stringFilters by tree sum ([Dimension].[Tree].[Sum]).no
HeaderbooleanIf 'True' the header is exported. The default value is 'True'.notrue
MaxRecordsnumberMaximum number of records to be exported. The default value is 500000.no500000
NullsbooleanIf 'True' empty records (all fields numbers:string = 0 and all text fields:string = '') are exported. The default value is 'True'.notrue
QuotedbooleanIf 'True' the text fields are quoted ("Text"). The default value is 'False'.nofalse
SecondFormatstringSecond format example: HH:MM:SSno
StartRecordnumberRecord 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
SubtablestringName of the subtable ([Subtable]). A subtable contains additional filters used by the table.no

Result

No fields

Code

text
EXPORT TABLE
FILE=[string, Needed]
TABLE=[string, Needed]
BRACKETS=[boolean, default=true]
CODING=[string, default=Utf8, values=[Ansi,Ascii,BigEndianUnicode,Unicode,Utf7,Utf8]]
DAYFORMAT=[string]
DECIMALSEPARATOR=[string, default=Point, values=[Comma,Point]]
FIELD=[string, Multiple]
FIELDSEPARATOR=[string, default=Tabulator, values=[Circumflex,Comma,Semicolon,Tabulator,Pipe]]
FILTER=[string, Multiple]
FILTERATTRIBUTE=[string, Multiple]
FILTERFIELD=[string, Multiple]
FILTERRANGE=[string, Multiple]
FILTERTREE=[string, Multiple]
HEADER=[boolean, default=true]
MAXRECORDS=[double, default=500000]
NULLS=[boolean, default=true]
QUOTED=[boolean, default=false]
SECONDFORMAT=[string]
STARTRECORD=[double, default=0]
SUBTABLE=[string]