Appearance
Export Table
Exports a table to a text file. The text file is saved on the server.
Permissions
| Command Kind | Needed User Kind |
|---|---|
| Read | Admin, Sys |
Parameters
| Name | Type | Description | Required | Default | Values |
|---|---|---|---|---|---|
| File | string | Name/path of the export file. The file is exported on the server. | yes | ||
| Table | string | Name of the table ([Table]). | yes | ||
| Brackets | boolean | If 'True' the dimension items are exported with brackets ([Item]). The default value is 'True'. | no | true | |
| Coding | string | Coding of the file: Ansi, Ascii, BigEndianUnicode, Unicode (Utf16/Utf-16), Utf7 (Utf-7) or Utf8 (Utf-8). The default value is Utf8. | no | Utf8 | Ansi, Ascii, BigEndianUnicode, Unicode, Utf7, Utf8 |
| DayFormat | string | Day format examples: YYYY-MM-DD, MM/DD/YYYY, MM-DD-YYYY, DD.MM.YYYY. | no | ||
| DecimalSeparator | string | Decimal separator (long and short): Comma (,) or Point (.). The default value is Point (.) | no | Point | Comma, Point |
| Field | array of string | Field to be exported (number or text). If no field is specified, all fields are exported. | no | ||
| FieldSeparator | string | Field separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|). | no | Tabulator | Circumflex, Comma, Semicolon, Tabulator, Pipe |
| Filter | array of string | Filters by dimension item ([Dimension].[Item]) or tree sum ([Dimension].[Tree].[Sum]). The tree sum format is equal to 'FilterTree'. | no | ||
| FilterAttribute | array of string | Filters by attribute ([Dimension].[Attribute].[Value]). | no | ||
| FilterField | array of string | Filters 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 | ||
| FilterRange | array of string | Filters by an item range ([Dimension].[StartItem].[EndItem]). | no | ||
| FilterTree | array of string | Filters by tree sum ([Dimension].[Tree].[Sum]). | no | ||
| Header | boolean | If 'True' the header is exported. The default value is 'True'. | no | true | |
| MaxRecords | number | Maximum number of records to be exported. The default value is 500000. | no | 500000 | |
| Nulls | boolean | If 'True' empty records (all fields numbers:string = 0 and all text fields:string = '') are exported. The default value is 'True'. | no | true | |
| Quoted | boolean | If 'True' the text fields are quoted ("Text"). The default value is 'False'. | no | false | |
| SecondFormat | string | Second format example: HH:MM:SS | no | ||
| StartRecord | number | Record 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. | no | 0 | |
| Subtable | string | Name 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]