HierarchySubsetAttrInsert

HierarchySubsetAttrInsert creates a new attribute for subsets on your TM1® server. The function creates a string, numeric, or alias attribute.

This function is valid in TM1 TurboIntegrator processes only.

Syntax

Note: If you update an existing subset attribute, you must first delete the existing attribute using the function HierarchySubsetAttrDelete. You can then use HierarchySubsetAttrInsert to recreate the attribute with your desired changes. If you attempt to update an existing attribute without first deleting it, the insert fails without a warning or error. The existing attribute remains unchanged; it is neither updated nor overwritten. 
HierarchySubsetAttrInsert( Dimension, Hierarchy, PrevAttrName, NewAttrName, AttrType);

Argument

Description

Dimension

The name of the dimension whose subsets are being updated.

Hierarchy

The name of a hierarchy in a dimension.

PrevAttrName

The attribute that precedes the attribute you are creating. If there is no previous attribute or you want the new attribute to be the first attribute for subsets, leave this argument empty.

NewAttrName

The name you want to assign to the new subset attribute.

AttrType

The type of attribute. There are three possible values for the AttrType argument:

  • N - Creates a numeric attribute.
  • S - Creates a string attribute.
  • A - Creates an alias attribute.

Example

This example creates the Description string attribute for subsets in the Z hierarchy of the Model dimension. Because there is no PrevAttrName parameter, this attribute is inserted as the first attribute for subsets on your TM1 server.

HierarchySubsetAttrInsert('Model', 'Z', '', 'Description', 'S');