DimensionElementComponentAdd TM1 Function: Use and Syntax

DimensionElementComponentAdd adds an existing element in a TM1 dimension into a hierarchy as a child of another element.  With this function, you can define what the weight of the element is to determine if the values are to be added or subtracted from the parent.

Syntax of DimensionElementComponentAdd

The syntax is:

DimensionElementComponentAdd ( DimName, ConsolidatedElName , ElName , ElWeight);

where:

  • DimName is the dimension you want to work with.
  • ConsolidatedElName is the element to which you want to add a child.
  • ElName is the name of the child element.
  • ElWeight is the weight of the child element. This is usually either 1 to add positive values, or -1 to subtract values from the parent. If you would like to read a full explanation of how to use weights, please see this post.

Usage and Example

DimensionElementComponentAdd is often used in combination with the DimensionElementInsert statement. Therefore, after you have added a new element, you then need to add it into a hierarchy.

DimensionElementComponentAdd (‘GL Account’, vParent_Account, vSub_Account, 1);

This will add the current contents of the variable vSub_Account to vParent_Account in the GL Account dimension with a weight of 1. In other words, positive values will add to the parent.

Often this function is used in conjunction with DIMIX to test if an element exists, and then DimensionElementInsert to insert it if it does not exist before finally using DimensionElementComponentAdd to add it into a hierarchy.

It might also be used with a DIMIX to test if a potential parent exists before having the element in question being added to that parent.

Notes

The opposite of this function is DimensionElementComponentDelete.

This function can only be used in Turbo Integrator processes. It also can only be used on Prolog or Metadata tabs.

If you like this post, please spread the love…

About John

Managing Director of Infocube. We are a management accounting consultancy that specialises in Business Analytics.

3 comments on “DimensionElementComponentAdd TM1 Function: Use and Syntax

This site uses Akismet to reduce spam. Learn how your comment data is processed.