AttachTree method: AnalyticModel class

Syntax

AttachTree(DimName, TreeName, setID, UserKeyValue, EffDt, NodeName, OverrideRecord, DetailStartLvl, TreeDiscardLvl)

Description

Use the AttachTree method to attach a tree to a dimension. Only one tree can be attached to a dimension at a time. You can only attach a tree before the analytic instance is loaded.

Parameters

Parameter Description

DimName

Specify the name of the dimension that you want to attach a tree to.

TreeName

Specify the name of the tree that you want to attach to the dimension.

setID

Specify the table indirection key for the tree. This parameter takes a string value. If the tree structure the tree is based on has its IndirectionMethod specified as "S", you must specify a setID.

If the tree structure doesn’t have its IndirectionMethod specified as "S", you must enter a Null string (that is, two quotation marks with no blank space between them ("")) for this parameter.

UserKeyValue

Specify the User Key Value for the tree. This parameter takes a string value. If the tree structure the tree is based on has its IndirectionMethod specified as "U" or "B", you must specify a User Key Value.

If the tree structure doesn’t have its IndirectionMethod specified as "U" or "B", you must enter a Null string (that is, two quotation marks with no blank space between them ("")) for this parameter

EffDt

Specify an effective date for this tree. This parameter takes a string value.

NodeName

Specify the tree node used as the dimension hierarchy root. This can be different from the tree root, that is, you can pick a subtree.

OverrideRecord

Specify the name of a record to be used for overriding the aggregate.

See Analytic Calculation Engine: Working with Overrides.

DetailStartLvl

Specify the tree level number (such as 1 for the node hierarchy root specified by the NodeName parameter) at which detail nodes start.

If you specify a value other than 0, any nodes at this level or greater than this level are considered details node, and any nodes with levels less than the start level are considered aggregate nodes

If you specify 0, detail nodes are nodes that don't have parents (a node can be a parent either by having children or by having child ranges).

TreeDiscardLvl

Specify the tree level number (such as 1 for the node hierarchy root specified by the NodeName parameter) at which to stop loading the tree. Nodes at this level or at levels greater are discarded. This parameter is only used if it has a value other than 0, and if it has a value greater than DetailStartLvl.

Returns

None.