Import Subtree

Imports a subtree from a text file. The text file is loaded from the server.

Permissions

Command Kind	Needed User Kind
Write	All

Parameters

Name	Type	Description	Required	Default	Values
Dimension	string	Name of the dimension ([Dimension]).	yes
File	string	Name/path of the import file. The file is imported on the server.	yes
Item	string	Column of the item or sum ([Column1]). The kind (item or sum) is specified with the parameter 'Kind'.	yes
Kind	string	Column of the kind ([Column1]). The kind contains the type of the record. By default 'Sum' or 'Item'. It is also possible to specify the kind directly, without a column: [Sum] or [Item].	yes
Subtree	string	Name of the subtree ([Subtree]). A subtree is a flat extract of items and sums of the tree.	yes
Tree	string	Name 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 dimension	yes
Adjust	boolean	If 'True' protected command chars are replaced: '[' becomes '(', ']' becomes ')' and '=' becomes empty. The default value is 'True'.	no	true
Attribute	string	Column of the attributes ([Column1]). The format is [Attribute].[Value], e.g. [Size].[L],[Color].[Blue]	no
Caption1	string	Column of caption 1 ([Column1]).	no
Caption2	string	Column of caption 2 ([Column1]).	no
Caption3	string	Column of caption 3 ([Column1]).	no
Caption4	string	Column of caption 4 ([Column1]).	no
Caption5	string	Column of caption 5 ([Column1]).	no
Caption6	string	Column of caption 6 ([Column1]).	no
Caption7	string	Column of caption 7 ([Column1]).	no
Caption8	string	Column of caption 8 ([Column1]).	no
Caption9	string	Column of caption 9 ([Column1]).	no
Caption10	string	Column of caption 10 ([Column1]).	no
Coding	string	Coding of the file: Automatic (checks the file), Ansi, Ascii, BigEndianUnicode, Unicode (Utf16/Utf-16), Utf7 (Utf-7) or Utf8 (Utf-8). The default value is Automatic	no	Automatic	Automatic, Ansi, Ascii, BigEndianUnicode, Unicode, Utf7, Utf8
Contains	string	If not empty, only rows containing this value are imported.	no
EditItems	boolean	The import can include captions and attributes. If 'True', the captions and attributes are used to change the dimension items. The default value is 'False'.	no	false
EditSums	boolean	The import can include attributes and captions. If 'True', the attributes and captions are used to change the sums. The default value is 'False'.	no	false
FieldSeparator	string	Field separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|).	no	Tabulator	Circumflex, Comma, Semicolon, Tabulator, Pipe
Headers	integer	Number of header lines. These are skipped at the import. The default value is '0'.	no	0
IgnoreErrors	boolean	If 'True' errors are ignored. If 'False' the command is stopped and an error message is displayed. The default value is 'False'.	no	false
ItemText	string	If a record contains an item, the kind column should contain 'Item'. The value 'Item' can be changed to a different text, e.g. 'I'	no
MaxRecords	integer	Max number of records to be imported. The default value is '0', which means all records are imported.	no	0
Quoted	boolean	If 'True' the text fields are quoted ("Text"). The default value is 'False'.	no	false
Skip	string	If not empty, rows containing the specified value are skipped.	no
SumText	string	If a record contains a sum, the kind column should contain 'Sum'. The 'Sum' can be changed to a different text, e.g. 'S'	no

Result

No fields

Code

IMPORT SUBTREE
DIMENSION=[string, Needed]
FILE=[string, Needed]
ITEM=[string, Needed]
KIND=[string, Needed]
SUBTREE=[string, Needed]
TREE=[string, Needed]
ADJUST=[boolean, default=true]
ATTRIBUTE=[string]
CAPTION1=[string]
CAPTION2=[string]
CAPTION3=[string]
CAPTION4=[string]
CAPTION5=[string]
CAPTION6=[string]
CAPTION7=[string]
CAPTION8=[string]
CAPTION9=[string]
CAPTION10=[string]
CODING=[string, default=Automatic, values=[Automatic,Ansi,Ascii,BigEndianUnicode,Unicode,Utf7,Utf8]]
CONTAINS=[string]
EDITITEMS=[boolean, default=false]
EDITSUMS=[boolean, default=false]
FIELDSEPARATOR=[string, default=Tabulator, values=[Circumflex,Comma,Semicolon,Tabulator,Pipe]]
HEADERS=[integer, default=0]
IGNOREERRORS=[boolean, default=false]
ITEMTEXT=[string]
MAXRECORDS=[integer, default=0]
QUOTED=[boolean, default=false]
SKIP=[string]
SUMTEXT=[string]