Appearance
Copy Records
Copies records from a source table to a destination table. The source table and the destination table can be identical.
Permissions
| Command Kind | Needed User Kind |
|---|---|
| Write | All |
Parameters
| Name | Type | Description | Required | Default | Values |
|---|---|---|---|---|---|
| Destination | string | Destination table. | yes | ||
| Source | string | Source table. | yes | ||
| Average | array of string | Copies the average of a field ([DestinationField].[SourceField]). | no | ||
| 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 | |
| Count | array of string | Copies the count of records ([DestinationField].[SourceField]). | no | ||
| CountItems | array of string | Copies the count of items ([DestinationField].[SourceDimension]). | no | ||
| 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 | |
| Dimension | array of string | The parameter has three parts. The second part is a fixed string, which specifies the operation. [Dimension].[Fixed].[Item] copies the values to one item. [Dimension].[Distribution].[Distribution] copies the values to the items according to the distribution. [Dimension].[DistributionTotal].[Distribution] copies the sum to the items according to the distribution. [Dimension].[ItemsCount] copies the values to the items according to the dimension. [Dimension].[ItemsTotal] copies the sum to the items according to the dimension. | no | ||
| 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 | ||
| FilterTreeFactor | array of string | Filters by tree sum ([Dimension].[Tree].[Sum]). The factor of the items and sums are used to calculate the values. | no | ||
| Max | array of string | Copies the maximum of a field ([DestinationField].[SourceField]). | no | ||
| Min | array of string | Copies the minimum of a field ([DestinationField].[SourceField]). | no | ||
| Parallel | boolean | If 'True' multiple threads are used. The default value is 'True'. | no | true | |
| Percent | array of string | Copies values with a percentage ([DestinationField].[SourceField].[Percent]). For example a percentage of 125 adds 25% to the value. | no | ||
| Sum | array of string | Copies the sum of a field ([DestinationField].[SourceField]). | no | ||
| Target | array of string | Copies values with a target value. ([DestinationField].[SourceField].[Target]). For example a target value of 1000 adjusts the source values to their proportion of the value of 1000. | no |
Result
No fields
Code
text
COPY RECORDS
DESTINATION=[string, Needed]
SOURCE=[string, Needed]
AVERAGE=[string, Multiple]
ADD=[boolean, default=false]
COUNT=[string, Multiple]
COUNTITEMS=[string, Multiple]
DATEOFFSET=[integer, default=0]
DIMENSION=[string, Multiple]
FACTOR=[string, Multiple]
FILTER=[string, Multiple]
FILTERATTRIBUTE=[string, Multiple]
FILTERFIELD=[string, Multiple]
FILTERRANGE=[string, Multiple]
FILTERTREE=[string, Multiple]
FILTERTREEFACTOR=[string, Multiple]
MAX=[string, Multiple]
MIN=[string, Multiple]
PARALLEL=[boolean, default=true]
PERCENT=[string, Multiple]
SUM=[string, Multiple]
TARGET=[string, Multiple]