---
title: "State tree dockable"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/state-tree-dockable/index.html"
---
## Overview

The State Tree dockable displays the contents of all the Gateways known to Active Console in a hierarchical view.

It can be displayed either in **Logical mode** or **Physical mode**:

- **Logical mode** — it is Managed entity-centric that refers to the items in your monitored environment. Only managed entities and their sub-components are available in this mode, which is also known as **Viewpath**.
- **Physical mode** — it is Gateway-centric that uses the Gateway names or attributes to display data in State Tree.

To switch to either logical or physical mode, click **State Tree** ![](https://docscdn.itrsgroup.com/geneos/images/Icons/toggleStateTreeMode16x16.png "icon") in the **Toolbar**.

The State Tree also displays the snooze status of
 data items and if a data item has an error. This includes not just
 whether the item itself is snoozed, but whether it has
 descendants or ancestors that are snoozed as well.

The icons and their meanings are:

| Snoozed item | Description |
|-------|-------|
| Snooze ![snooze](https://docscdn.itrsgroup.com/geneos/images/Icons/snooze12x12.png "icon") | Data item itself is snoozed. |
| Snooze Child ![snooze-child](https://docscdn.itrsgroup.com/geneos/images/Icons/internalsnooze12x12.png "icon") | Data item is not snoozed, but has one or more descendants that are snoozed. |
| Snooze Parent ![snooze-parent](https://docscdn.itrsgroup.com/geneos/images/Icons/externalsnooze12x12.png "icon") | Data item is not snoozed, but has one or more ancestors that are snoozed. |
| Snooze Child/Parent ![snooze-child-parent](https://docscdn.itrsgroup.com/geneos/images/Icons/internalExternalSnooze12x12.png "icon") | Data item is not snoozed, but has one or more descendants and ancestors that are snoozed. |

To learn more about the icons that you can see in the State Tree, see [Icons and Format Strings](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/icons-and-format-strings/index.html).

## Edit the viewpath and order of entities view

The **Viewpath** is used when the State Tree is in logical mode. It uses the managed entity attributes to sort the tree into logical groups:

- If no viewpath is defined, then the state tree contains a list of all the managed entities configured in the connected gateways.
- If a viewpath is defined, then the state tree groups together the managed entities that have the same attribute value.

To customise the State Tree view, go to **Workspace settings > General > Viewpath**. For reference, see [Workspace Settings](/visualization/active-console/view-customization/../configuration/workspace-settings/#general-settings).

For example, this is the default order of managed entities in the State Tree:

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-state-tree-default.png)

When you modify the **Viewpath** settings following the `Country,Environment,Purpose,Role,Monitoring,Platform,Version` order, this changes the order of managed entities in the State Tree to:

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-state-tree-viewpath-edited.png)

For example, if you have four managed entities (ME):

- ME1, with attributes 'Country = England' and
 'City = London'
- ME2, with attributes 'Country = France' and 'City
 = Paris'
- ME3, with attributes 'Country = England' 'City =
 London'
- ME4, with attributes 'City = Hong Kong' and 'OS =
 Windows'
- ME5, with attributes 'Country = England' and
 'City = Manchester' and OS='Linux'
- ME6, with attributes 'Country = France'

And the viewpath setting is "Country, City, OS". Then, the
state tree is organised in the following way:

- England
  - London
    - ME1
    - ME3
  - Manchester
    - Linux
      - ME5
- France
  - ME6
  - Paris
    - ME2
- Hong Kong
  - Windows
    - ME4

In the given example, the items are sorted by the attributes defined in
 the Viewpath in order:

- The system gets the **Country** attribute of all the managed
 entities and create entries for each unique Country
 before putting the relevant managed entities under each
 Country.
- It divides the set of managed
 entities under each unique Country by the second
 **City** attribute.

This process continues until all
 the view path attributes are applied.

Where a managed entity does not have a value for a
 given attribute (in the example above ME4 does not have
 a Country), it is classified under an instance
 of the attribute (for example, England). Instead, it is inserted at the same level in the State Tree as the unique
 values for the attribute.

The net result is that
 Gateways can have entirely independent viewpaths, and
 still be displayed successfully in logical view
 mode.


**Note**

  The definition of the attributes in the view path 
 setting is case sensitive. By default, all items in the State Tree are ordered alphabetically.


You can force specified items
 to occur at the top of the items at any given level in
 the state tree by specifying them in the **Order
 preference** field.

1. Go to **ActiveConsole Settings > General > Order preference** field.
2. Type the order preference.
3. Click **Apply**, and then click **OK**.

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-state-tree-order-preference.png)


**Note**

  The definition of order preference is case 
 sensitive; any item that occurs in the State Tree can
 be specified in this way. You can specify many items in
 the Order preference (separated by commas) with items
 at the beginning of list taking preference over items
 at the end of the list.


## Limit the State Tree content

To restrict the level of data items that appear in the State Tree:

1. Go to **Workspace settings > Advanced > General > State tree leaf type**.
2. Select the preferred option on the **State tree leaf type** menu.
3. Click **Apply**, and then click **OK**.

These options are available on the **State tree leaf type** menu:

- **DataView** — navigate down to the dataview
 level.
- **Sampler** — navigate down to the sampler level, but
 not dataviews.
- **ManagedEntity** — the state tree
 stops at the managed entity level and does not
 display the samplers or dataviews.


**Note**

  The primary reason for restricting 
 the data items in the state tree is due to performance.
 Stopping at the Managed Entity level is more
 efficient than stopping at the Dataview
 level. Workspaces that connect to larger
Gateways gets significant performance gains on
 startup if the state tree is restricted.