Tree Action Parameters

Learn about the Tree Action Paramaters.

To call a Tree view from a context menu or a button, define the Tree action with its treeViewName and the record used as root (uid). If no TreeView configuration is specified, the default TreeView configuration <infoAreaId> is used.

If a TreeView configuration belongs to an info area other than the info area of the record passed to the tree, not the tree root but the record passed to the tree is automatically highlighted and expanded if configured that way. This allows you e.g. to call a company tree view configuration from the person context menu, and have the tree expanded so that the person is highlighted within the tree.

The Tree action supports the following input arguments:

treeViewName

The name of the TreeView configuration. For further details, see TreeView Configuration.

If undefined, the TreeView configuration <infoAreaId> is used. The TreeView configuration for the info area from which the action is called.

You can use the prefix %% as a placeholder for the info area: Thus, e.g. instead of defining different actions for IBHierarchyTree and KMHierarchyTree, you can define one action (A_HierarchyTree in UPDATE_DEFAULT) specifying %%HierarchyTree as treeViewName.

uid

The record to be displayed as the tree's root node.

This parameter is mandatory.

Record: The current record is displayed as the tree's root node.

Linked: The parent record of the current record is displayed as the tree's root node.

link

Record to which the tree's root record is linked (Record, Linked or undefined).

Defines the link to the parent record, only used if the specified record acts as a link record to the tree’s root record.

linkId

The ID of the link used for link. This parameter is only relevant if multiple data model links between two info areas exist (example - multiple FI-links in KM). For further details, see Link IDs.

Default=-1, which corresponds to the default link

headerGroupName

Defines the header group for the Tree header.

You can use the prefix %% as a placeholder for the info area: Thus, for example instead of defining different actions using IBHierarchyHeader and KMHierarchyHeader, you can define one action (A_HierarchyTree in UPDATE_DEFAULT) specifying %%HierarchyHeader as headerGroupName.

The Expand headers for the tree's sub-info areas are taken from the header group specified in the sub-info areas' Expand configurations. For further details, see Record Settings.

viewMode

The initial view mode of the Expand views accessed from the tree. Available values: Edit, Read.

This parameter overrules the standard behavior, i.e. the Expand view of tree node records being displayed read-only or editable according to the TreeView configuration (Readonly flag). For further details, see Node Settings.

If viewMode=Read, all details masks are displayed read-only, regardless of the TreeView configuration. However, if the Expand header contains an Edit button, the user can manually switch to Edit mode if the tree view configuration does not also define the details as read-only.

Default: Read

expandOptions

Determines the active Details control and sub-list tabs when initially displaying a record in Tree view.

Syntax:

<Name>,<Value>;<Name2>,<Value2>;

The following settings are available:

  • initialTab,<0-based number>: Determines the initially active Details control tab.
  • initialSubListTab,<0-based number or info area ID>: Determines the initially active sub-list tab.
Note: It is recommended to use the info area ID for initialSubListTab since this continues to work even if the tab order is changed at some later point in the project.

Examples:

  • initialTab,2;initialSubListTab,3; initially activates the 3rd tab of the Details control and the 4th sub-list tab.
  • initialTab,2;initialSubListTab,MA; initially activates the 3rd tab of the Details control and the (first) Activities sub-list.

walkUpToRootRecord

If set to 1, the tree is defined as a hierarchy tree to display e.g. a ticket with its sub-tickets: The root record of the tree is determined from the chain of parent records starting at the record defined by uid.

Hierarchy trees are supported for the following info areas: A1, OJ, KM, IB, and MA.

Note: If an item references itself, it is only displayed once in the hierarchy.

createNewTab

See  createNewTab in Expand Action Parameters.

createNewPopup

See createNewPopup.

history

The page is not added to the page-related browsing history. This parameter cannot be changed.

relationName

See relationName.