Node

When you select a node object in a derived property expression or a sourceNode object in a property transformation expression, you can select node attributes depending on the data type of the node object:

Table 23-4 Node Objects and Attributes

Node Object Description Attributes and Methods of Object
Actions

Returns a list of request action objects for the node in a request.

(Available for subscription filters, policy filters, and custom validations only.)

  • Any
  • Count
  • Filter
  • Find
  • Get
  • IsEmpty
  • Size

Action object: see Action Object Attributes table, below.

AllAncestors Returns all ancestor node objects combined from all node locations in the node set. See Node List.
Ancestors Returns ancestor node objects for a node instance in the node set See Node List.
BoundAncestors

In hierarchy set bound viewpoints, returns a list of ancestor nodes for a node in the bound viewpoint.

In node type bound or unbound viewpoints, returns ancestor node objects for a node instance (the same result as when using Ancestors).

See Node List.
BoundLocations

In hierarchy set bound viewpoints, returns a list of locations for a node in the bound viewpoint.

In node type bound or unbound viewpoints, returns node locations (the same result as when using Locations).

Optional: Enable Exclude Implicit Shares to filter the returned list of bound locations to only node instances under unique parents.

Tip:

Using the bound versions of Ancestors and Locations enables you to access the full scope of the bound viewpoint when using an expression in a maintenance viewpoint.
See Node List.
Children Child node objects for a node. See Node List.
CompareTo Compare two node locations with these options:
  • SAME_LOCATION: Node location is the same as a specified node location
  • SAME_PARENT_AND_NODE: Node location has the same parent as a specified node location
  • SUBSET_LOCATION: Node location has a set of contiguous ancestors that is the same as a specified node location

Tip:

This enables you to build an expression that returns different results based on a comparison of node locations. For example, you can derive the value of a Data Storage property as stored or shared based on whether a particular node is the first location in the hierarchy and whether it shares a parent or ancestors with other node locations.

Node for the compare.
Dimension Node dimension name attribute
HierarchySet Hierarchy set of a node in a viewpoint. name attribute
Locations Node locations (can contain node instances).
  • Optional: Enable Exclude Implicit Shares to filter the returned list of locations to only node instances under unique parents.
  • Optional: Enable Sort to return the locations in the order in which they appear in a hierarchy viewpoint. This allows business logic for shared nodes based on hierarchy order to be implemented. For example, you can create a derived Data Storage property for Planning dimensions which assigns the first member instance a Stored value and other member instances in the hierarchy a Shared value.

See Node List.
Name Node name See Strings, Numeric Strings, and Sequences
NextSibling Node sibling after a node in the hierarchy. If this is the last node, then the NextSibling attribute returns Null.
  • dimension
  • name
  • nodeType
  • properties
NodeSet Node set for a node. (Available for calculated and stored Parent properties only) name attribute
NodeType Node type for a node. name attribute
Parent Node parent Parent also has the Node data type, which means that you can select other node attributes such as the dimension or the node type of the parent. However, you cannot select the parent of a parent.
PreviousSibling Node sibling before a node in the hierarchy. If this is a first node without a previous sibling, then the PreviousSibling attribute returns Null.
  • dimension
  • name
  • nodeType
  • properties
Properties Node properties. See Properties.
Siblings Sibling node objects for a node instance. See Node List.

Table 23-5 Action Object Attributes

Object Attribute Description Attributes and Methods of Returned Object
CreatedBy User who created the request action
  • isMemberOf

    Parameter: the name of the group to check

  • username
ModifiedBy User who modified the request action
  • isMemberOf

    Parameter: the name of the group to check

  • username
PropertyName Name of property in the request action See Method or Attribute in Strings, Numeric Strings, and Sequences.
Type The type of request action
  • isAdd
  • isDelete
  • isInsert
  • isMove
  • isRemove
  • isRename
  • isReorder
  • isUpdate
ViewpointName Name of the viewpoint in the request action. See Method or Attribute in Strings, Numeric Strings, and Sequences.