{"id":33519,"date":"2017-11-29T15:55:06","date_gmt":"2017-11-29T07:55:06","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=33519"},"modified":"2017-12-15T11:37:21","modified_gmt":"2017-12-15T03:37:21","slug":"hierarchy-query-4-5-2","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/triggers\/hierarchy-query\/hierarchy-query-4-5-2\/","title":{"rendered":"Hierarchy Query (4.5.2)"},"content":{"rendered":"\n

This article applies to versions 4.5.2 and later of P2 Explorer. For the latest, see Hierarchy Query<\/a>.<\/p>\n

The Triggers panel in Studio mode is where you can set up controls for updating or manuipluating variables; these controls are not visible on the Explorer page.<\/p>\n

This topic covers the Hierarchy Query control, and how to use it.<\/p>\n

To open the Triggers panel, click the Triggers button in the Configuration<\/em> group on the Studio ribbon tab.<\/p>\n

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

Hierarchy Query Overview<\/h2>\n

A Hierarchy Query is used to generate a list of child entities from a defined hierarchy, for a selected entity. It also exposes the primary template name for the selected hierarchy. Using a hierarchy query, you could display the children of a selected entity with some of their attributes, in a chart or a table layout. For example, show the oil and water production figures (attribute values) for all oil producing wells (child entities) of a particular region (selected entity).<\/p>\n

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

Here are examples of how a selected entity's children are returned by a hierarchy query. The child entities are assigned to a variable, and can then be used elsewhere on the page, or sent to another page or to a trend using a hyperlink. The configuration of the hierarchy query determines how many levels of child entities are assigned to the variable, as well as whether to filter on one or more defined templates.<\/p>\n\n\n\n\n
\"\"<\/a><\/td>\n\"\"<\/a><\/td>\n<\/tr>\n
Child entities of selected entity going down one level<\/em><\/td>\nChild entities of selected entity going down two levels<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Below is an example of the child entities from the level below the selected entity, appearing on a page in a chart. The query has been configured so that only entities whose primary template<\/strong> is an Oil Producing Well<\/strong> template are included in the set of child entities.<\/p>\n\n\n\n
\"\"<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

You can configure a hierarchy query to select a set of child entities as follows:<\/p>\n\n\n\n
\n\n\n\n
\"\"<\/a><\/td>\n\n\n\n\n
\n

1. Hierarchy Name<\/strong>:
\n Select a hierarchy to query from. Either select a variable, or select a hierarchy from the drop-down list of hierarchies that exist in P2 Server.<\/p>\n

2. Entity<\/strong>:
\n Assign a fixed entity name, or more commonly a variable entity that the user will update from another page control. This is the entity whose children the hierarchy query returns.<\/p>\n

3. Levels<\/strong>:
\n Specify how many levels to fetch from, below the selected entity (1 for one level down, 2 for two levels, and so on). The default is one level (1).<\/p>\n

4. Template Filters<\/strong>:
\n Optionally add one or more template filters, to restrict what type of entity to fetch. This is covered in the tutorial<\/a> in more detail, under Adding Template Filters<\/em>.<\/p>\n

5. Filter By Primary Only<\/strong>:
\n You can further restrict to child entities where their primary template is one of the listed template filters.<\/p>\n

6. Child Entities<\/strong>:
\n The child entities returned by the query are assigned to an entity list variable (the default variable is called childEntities<\/em>).<\/p>\n

More Settings [7-10]<\/strong>:
\n There are extra settings associated with the hierarchy query, under the More Settings<\/em> section. Click More Settings<\/em> to expand this section, and Less Settings<\/em> to collapse it.<\/p>\n

7. Current Template<\/strong>:
\n Use this property to assign the name of the selected entity's current primary template to a variable (called currentTemplate<\/em> by default).<\/p>\n

8. Page Number<\/strong>:
\n You can use the Page Number, Page Size and Total Record Count in conjunction with a Paging Control<\/a>, to allow paging of the child entities.<\/p>\n

9. Page Size<\/strong>:
\n You can use the Page Number, Page Size and Total Record Count in conjunction with a Paging Control, to allow paging of the child entities.<\/p>\n

10. Total Record Count<\/strong>:
\n You can use the Page Number, Page Size and Total Record Count in conjunction with a Paging Control, to allow paging of the child entities. Or use this property independently; it sets a variable for the number of children for the current entity selection for this particular hierarchy query.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

A hierarchy is an organised structure of entities, which models an organisation's assets. Read more about the Hierarchy Navigator<\/strong><\/a>, the Hierarchy<\/strong> page component<\/a>, and setting up a hierarchy in Server Management<\/a>.<\/p>\n

Tutorial<\/h2>\n

In this tutorial, we'll add and configure a hierarchy query, a hierarchy component to control it, a selection list to display its child entities and a text label to describe the child entities.<\/p>\n

Later in the tutorial we'll show how to change the hierarchy query by changing the Levels<\/strong> and adding Template Filters<\/strong>, as well as selecting the Filter By Primary Only<\/strong> check box.<\/p>\n

Finally, we'll work with the paging properties of the hierarchy query.<\/p>\n

At the end of the tutorial, we'll have something that looks like this:<\/p>\n

\"\"<\/a><\/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

Setting up a Page with a Basic Hierarchy Query<\/h3>\n

There are four steps in the first part of the tutorial:<\/p>\n