Skip to content

Set Record

Sets a table record. An item must be specified for each dimension.

Permissions

Command KindNeeded User Kind
WriteAll

Parameters

NameTypeDescriptionRequiredDefaultValues
Itemarray of stringDimension and item ([Dimension].[Item]).yes
TablestringName of the table ([Table]).yes
AddbooleanIf 'True', the new value is added to an existing one. If 'False', the new value overwrites an existing one. The default value is 'False'.nofalse
AdjustbooleanIf 'True' protected command chars are replaced: '[' becomes '(', ']' becomes ')' and '=' becomes empty. The default value is 'True'.notrue
CreateItemsbooleanIf 'True' non existing items will be created. The default value is 'False'.nofalse
DateOffsetintegerMoves the date dimension items by the offset. The default value is '0'. For example the month '2022-02' with an offset of 5 becomes '2022-07'.no0
SubtablestringName of the subtable ([Subtable]). A subtable contains additional filters used by the table.no
Valuearray of stringSets the value of a number field ([Field Name].[123.45]) or text field ([Field Name].[Text]).no

Result

NameTypeDescription

Code

text
SET RECORD
ITEM=[string, Multiple, Needed]
TABLE=[string, Needed]
ADD=[boolean, default=false]
ADJUST=[boolean, default=true]
CREATEITEMS=[boolean, default=false]
DATEOFFSET=[integer, default=0]
SUBTABLE=[string]
VALUE=[string, Multiple]