Change Records

Changes the dimension items of records.

Permissions

Command Kind	Needed User Kind
Write	All

Parameters

Name	Type	Description	Required	Default	Values
Change	array of string	A specified dimension item can be changed ([Dimension].[Old Item].[New Item]) or all items of a dimension can be changed ([Dimension].[New Item])	yes
Table	string	Name of the table ([Table]).	yes
Add	boolean	If 'True', the new value is added to an existing one. If 'False', the new value overwrites an existing one. The default value is 'False'.	no	false
DateOffset	integer	Moves 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'.	no	0
Factor	array of string	A number value is changed via a factor ([NumberField].[Factor]). For example a factor of 1.25 adds 25% to the value.	no
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
Percent	array of string	A number value is changed via a percent ([NumberField].[Factor]). For example a percent of 125 adds 25% to the value.	no
Subtable	string	Name of the subtable ([Subtable]). A subtable contains additional filters used by the table.	no
Value	array of string	Sets the value of a number field ([Field Name].[123.45]) or text field ([Field Name].[Text]).	no

Result

No fields

Code

CHANGE RECORDS
CHANGE=[string, Multiple, Needed]
TABLE=[string, Needed]
ADD=[boolean, default=false]
DATEOFFSET=[integer, default=0]
FACTOR=[string, Multiple]
FILTER=[string, Multiple]
FILTERATTRIBUTE=[string, Multiple]
FILTERFIELD=[string, Multiple]
FILTERRANGE=[string, Multiple]
FILTERTREE=[string, Multiple]
PERCENT=[string, Multiple]
SUBTABLE=[string]
VALUE=[string, Multiple]