{"id":1417,"date":"2017-12-20T00:31:01","date_gmt":"2017-12-19T16:31:01","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=1417"},"modified":"2024-10-23T14:20:48","modified_gmt":"2024-10-23T06:20:48","slug":"hierarchy","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/hierarchy\/","title":{"rendered":"Hierarchy"},"content":{"rendered":"\n

This article applies to versions 4.4 and later of IFS OI Explorer. For more, see Release History<\/a>.<\/p>\n

Overview<\/h2>\n

The hierarchy control allows a user to select an entity from a specific hierarchy. This control is often used in conjunction with the hierarchy picker.<\/p>\n

First, the user selects the hierarchy from the hierarchy picker. The hierarchy control then makes the entities in that hierarchy available to the user, who will pick the entities they are interested in. Users can also search for entities in the hierarchy.\u00a0<\/p>\n

Related: Hierarchy Picker tutorial<\/a><\/p>\n

The following image shows 2 configured hierarchy controls. On the left, the user can select multiple entities, on the right the user can select only one entity:<\/p>\n\n\n\n\n
\"Hierarchy<\/a><\/td>\n\"Hierarchy<\/td>\n<\/tr>\n
Multiple entity selection<\/em><\/td>\nSingle entity selection<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Related: Using a Hierarchy<\/a> in display mode, Adding a new Hierarchy style<\/a><\/p>\n

\n

Configuring Hierarchies<\/h2>\n

There are 2 configuration modes. Basic mode shows the options most commonly used. Advanced mode allows you to change the type of properties used.<\/p>\n

Basic Mode<\/h3>\n

\"Hierarchy<\/a>\u00a0<\/p>\n

Advanced Mode<\/h3>\n

In Advanced mode, you have the option of choosing a variable to drive the Hierarchy Name. To do this, you first need to add the variable to the default values<\/a>, then you will be able to select it from the drop-down list.<\/p>\n

\"Hierarchy<\/a><\/p>\n

\u00a0<\/div>\n\n\n\n\n\n\n
Select Mode<\/strong>:<\/td>\nSingle or Multiple. Defines whether you will allow the user to only select a single entity, or to select multiple entities.<\/td>\n<\/tr>\n
Selected Entity<\/strong>:<\/td>\nThe name of the variable\u00a0that the hierarchy publishes to when the user selects an entity or entities. If the Multiple<\/em> select mode is chosen, this will change to \"Selected Entities\". This variable\u00a0will contain the entities that are selected, and other components\u00a0(such as a chart) can read from this variable.<\/td>\n<\/tr>\n
Hierarchy Name<\/strong>:<\/td>\nThe name of the hierarchy from which to display entities. The hierarchy must already exist in IFS OI Server.\u00a0<\/td>\n<\/tr>\n
Style<\/strong>:<\/td>\nThe style you want to apply to the Hierarchy\u00a0component.\u00a0If you are a Style Administrator,\u00a0you can\u00a0add a new Hierarchy\u00a0style<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

Tutorial:\u00a0Creating a Hierarchy That Drives a Pie Chart<\/span><\/h2>\n

If you're unfamiliar with the process of building pages, read the article Building an Explorer Page.<\/p>\n

In this tutorial, we\u2019ll look at adding a Hierarchy to a page, along with a Pie Chart. When the user selects entities from the Hierarchy, the Pie Chart updates to reflect data for the selected entities.\u00a0<\/p>\n

\"Hierarchy<\/a><\/p>\n

Let\u2019s go through this process, step-by-step.<\/p>\n

Note<\/strong>: This configuration uses the Sample Data table<\/em> that can be optionally made available\u00a0during initial installation and setup. If you don't have access to this data, you will need to adjust the configuration to suit your data at your site.<\/p>\n

\u00a0<\/p>\n

Step 1. Prepare a Studio Page<\/strong><\/p>\n

\"New<\/p>\n

Before you start, click the New Page<\/strong>\u00a0button on the Home tab of the ribbon. Choose the Grid layout.<\/p>\n

\"Grid<\/p>\n

Related: Grid Layout tutorial<\/a><\/p>\n

\u00a0<\/p>\n

Step 2. Add the Hierarchy to the Page<\/strong><\/p>\n

\"Hierarchy<\/a><\/p>\n

Drag and drop the Hierarchy<\/strong> <\/em>component\u00a0onto the upper\u00a0right grid cell.\u00a0The Hierarchy\u00a0is in the Hierarchy\u00a0\"hierarchy\"<\/a>\u00a0group.<\/p>\n

 <\/p>\n

Step 3.\u00a0\u00a0Configure the\u00a0Hierarchy<\/strong><\/p>\n

\"Hierarchy<\/a><\/p>\n

In this step, we want to allow users to select multiple entities from a hierarchy that we have specified. We can use the basic configuration for this.<\/p>\n

Configure the settings as follows:<\/p>\n