Skip to content

Import Formula

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

Permissions

Command KindNeeded User Kind
WriteAll

Parameters

NameTypeDescriptionRequiredDefaultValues
DimensionstringName of the dimension ([Dimension]).yes
FilestringName/path of the import file. The file is imported on the server.yes
FormulastringName of the formula ([Formula]). A formula is a flat structure of a dimension. A Formula is build of items and sums. Sums are calculated with functions.yes
ItemstringColumn of the item or sum ([Column1]). The kind (item or sum) is specified with the parameter 'Kind'.yes
KindstringColumn of the kind ([Column1]). The kind contains the type of the record. By default 'Sum' or 'Item'.yes
AdjustbooleanIf 'True' protected command chars are replaced: '[' becomes '(', ']' becomes ')' and '=' becomes empty. The default value is 'True'.notrue
AttributestringColumn of the attributes ([Column1]). The format is [Attribute].[Value], e.g. [Size].[L],[Color].[Blue]no
Caption1stringColumn of caption 1 ([Column1]).no
Caption2stringColumn of caption 2 ([Column1]).no
Caption3stringColumn of caption 3 ([Column1]).no
Caption4stringColumn of caption 4 ([Column1]).no
Caption5stringColumn of caption 5 ([Column1]).no
Caption6stringColumn of caption 6 ([Column1]).no
Caption7stringColumn of caption 7 ([Column1]).no
Caption8stringColumn of caption 8 ([Column1]).no
Caption9stringColumn of caption 9 ([Column1]).no
Caption10stringColumn of caption 10 ([Column1]).no
ClearbooleanIf 'True' all items of the formula are deleted before import. The default value is 'True'.notrue
CodingstringCoding 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 AutomaticnoAutomaticAutomatic, Ansi, Ascii, BigEndianUnicode, Unicode, Utf7, Utf8
ContainsstringIf not empty, only rows containing this value are imported.no
CreateItemsbooleanIf 'True' non existing items will be created. The default value is 'False'.nofalse
DecimalSeparatorstringDecimal separator (long and short): Comma (,) or Point (.). The default value is Point (.)noPointComma, Point
EditItemsbooleanThe import can include attributes and captions. Usually the attributes and captions are used for sums. If 'True', the attributes and captions also change the dimension items. The default value is 'False'.nofalse
FactorstringColumn of the factor ([Column1]).no
FieldSeparatorstringField separator (long and short): Circumflex (^), Comma (,), Semicolon (😉, Tabulator (Tab) or Pipe (|).noTabulatorCircumflex, Comma, Semicolon, Tabulator, Pipe
HeadersintegerNumber of header lines. These are skipped at the import. The default value is '0'.no0
IgnoreErrorsbooleanIf 'True' errors are ignored. If 'False' the command is stopped and an error message is displayed. The default value is 'False'.nofalse
InvisiblestringColumn that determines the invisibility ([Column1]).no
InputstringColumn of the formula input ([Column1]).no
ItemTextstringIf 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
MaxRecordsintegerMax number of records to be imported. The default value is '0', which means all records are imported.no0
QuotedbooleanIf 'True' the text fields are quoted ("Text"). The default value is 'False'.nofalse
RubricstringColumn of the rubric ([Column1]).no
SkipstringIf not empty, rows containing the specified value are skipped.no
SumTextstringIf a record contains a sum, the kind column should contain 'Sum'. The 'Sum' can be changed to a different text, e.g. 'S'no
ThousandSeparatorstringThousand separator (long and short): None, Apostrophe ('), Comma (,), Point (.) or Space (_).no

Result

No fields

Code

text
IMPORT FORMULA
DIMENSION=[string, Needed]
FILE=[string, Needed]
FORMULA=[string, Needed]
ITEM=[string, Needed]
KIND=[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]
CLEAR=[boolean, default=true]
CODING=[string, default=Automatic, values=[Automatic,Ansi,Ascii,BigEndianUnicode,Unicode,Utf7,Utf8]]
CONTAINS=[string]
CREATEITEMS=[boolean, default=false]
DECIMALSEPARATOR=[string, default=Point, values=[Comma,Point]]
EDITITEMS=[boolean, default=false]
FACTOR=[string]
FIELDSEPARATOR=[string, default=Tabulator, values=[Circumflex,Comma,Semicolon,Tabulator,Pipe]]
HEADERS=[integer, default=0]
IGNOREERRORS=[boolean, default=false]
INVISIBLE=[string]
INPUT=[string]
ITEMTEXT=[string]
MAXRECORDS=[integer, default=0]
QUOTED=[boolean, default=false]
RUBRIC=[string]
SKIP=[string]
SUMTEXT=[string]
THOUSANDSEPARATOR=[string]