Tree components

Tree components summarize data by one or more fields from your data source. Tree components are not dependent on date or time, so you can display them without using date and time filters. If based on a filter, they retrieve the result set and group the selected fields, providing a summary of your data rather than the full results. If filters are absent, all data for the selected fields is displayed from the data source.

Tree components require a primary series, and the sort values are applied based on the primary series you select.

Within a single tree component, you can have multiple independent series, each retrieved from different a data source if required. You can also set up a calculated series, which is a new series based on a mathematical expression that uses values from the other series as parameters. When using a calculated series, you have the option to hide any series used in the calculation.

Another property of the tree component is that you can break down values from a single field into the hierarchy. Where a data field contains a hierarchy structure (such as First.Second.Third), the tree component can split this into separate values and insert them into the hierarchy using a hierarchy field. See the example below. 

This example displays the same data, but in the case on the left, the Incident Area is specified as a hierarchy field with a delimiter of ".".  The values are then split based on the delimiter, and a hierarchy is created.

Complete this procedure in either the Dashboard or Document Designer. This procedure assumes content from one of your data sources is already open in the details pane and displayed in a tree-component format.

To edit components in a saved dashboard, you must first click the icon.

1.In the title bar of the tree component you want to edit, click the icon and select Component.

2.The Tree Component dialog displays the following options:

•General tab

•Title: Title for the tree component as it appears in the details pane.

•Series: A series list defined for the component. For details about setting up a series, see the section below.

•Output tab

•Sort: Sort order for the summarized data. By default, the value is applied to the primary series.

•Sort series: Apply a sort order to the list of defined series. An asterisk refers to the primary series.

•Hide 0’s: Hide data slices that show only a zero (no real data value) when the format is a grid.

•Show title summary: Xtraction creates a title summary of what the component does, along with your own title. If you clear this option, the default summary is removed. For example, the title "Incidents (Last Month)" becomes just "Incidents."

•Show collapsed: Select if you want the grid view collapsed by default.

•Alert rules tab

•Select colors to use in the results triggered by values within the data. Right-click in the columns area and select Add rule to enter an operation, value, colors for text and background, and notes about the rule if needed. Any added notes will display in the component header when you mouse hovers over the notes icon.

•Note that alert rules at the series level will override alert rules at the component level.

•Notes tab

•Enter explanatory text directly into the blank area, which will display when your mouse hovers over the notes icon for the component. If Show notes is selected for an export, these notes are included in that component export.

Tree-component series

Follow the next procedure to define a tree-component series. Tree components can display multiple, independent series at one time, meaning you can view data from multiple data sources within a single tree component if desired.

1.In the Tree Component dialog > General tab > Series area, right-click and select Add series.

2.The Tree Component Series dialog displays with these options:

•General tab

•Title: Title for the tree series.

•Name: Optional. Name of the series if it's being used within a calculated series.

•Data source: Data source used for this series.

•Fields: Fields on which data is to be summarized. Right-click in the Fields area and select Add field. Drag and drop the fields you want to include into the Selected Fields area and click OK. If this field contains a hierarchy structure that you want to view, you must complete the next procedure as well.

•Summary type/field: Summary condition (options include count, sum, average, min, and max) and field you want to summarize.

•Output tab

•Value format: Format used when displaying numerical values.

•Visible: Select if you want the series to be visible in output.

•Filter tab

•Criteria used to filter the data from the data source. Right-click in the blank area and select to create filter or open a saved one. For details about filters, see Filtering data.

•Alert rules tab

•Select colors to use in the results triggered by values within the data. Right-click in the columns area and select Add rule to enter an operation, value, colors for text and background, and notes about the rule if needed.

•Note that alert rules at the series level will override alert rules at the component level.

Tree-component hierarchies

Where a data field contains a hierarchy structure (such as First.Second.Third), the tree component can split the structure into separate values and insert them into the hierarchy using a hierarchy field.  

1.In the Tree Component Series dialog > General tab > Fields area, double-click a field name.

2.The Tree Component Field dialog displays the details for that field:

•Field: The field to summarize.

•Is hierarchy field: Select if this field contains hierarchy data separated by a delimiter.

•Hierarchy field delimiter: The string delimiter used to split the field's value. (For example, if a field contains data in the format Parent.Child.Child2, set the delimiter as "."). When the tree component is being built, this value is then split into three parts (Parent, Child, and Child2) and is inserted into the tree at the appropriate level.

Calculated series

A calculated series enables you to create a new series for the tree component based on a mathematical expression that uses values from the other series as parameters. When using a calculated series, you have the option to hide any series used in the calculation.

1.In the Tree Component dialog > General tab > Series area, right-click and select Add calculated series.

2.The Tree Component Series dialog displays with these options:

•General tab

•Title: Title for the series.

•Name: Name of the series for use within the calculated series expressions.

•Expression: A mathematical expression used to calculate the required value. For details, see the Expressions section below. To ensure your entry is valid, click the checkmark icon.

•Output tab

•Value format: Format for displaying numerical values.

•Visible: Select if you want the series to be visible in output.

•Alert rules tab

•Select colors to use in the results triggered by values within the data. Right-click in the columns area and select Add rule to enter an operation, value, colors for text and background, and notes about the rule if needed.

Use expressions to calculate values for your series. Expressions can use values from other series as parameters. Currently, expressions are limited to returning only numerical values.

You can use the following items within an expression:

Parameters

Parameters are case sensitive, and you need to enclose them in square brackets.

•[S1]: Current value for series one.

•[S1_TOTAL]: The total for series one.

Expressions can use values from other series when being evaluated. There are two ways to refer to another series—by using the series index, or by using the series name (if set up):

•Series index: You can refer to another series by using its index. The index for the first series is 1 and the second series is 2. For example, when adding two series together: [S1] + [S2]

•Series name: If you've set up the series with a name, you can refer to it by that name in an expression: [INCIDENTS] + [REQUESTS]

Operators

•Add (+): [S1] + [S2]

•Subtract (-): [S1] - [S2]

•Multiply (*): [S1] * [S2]

•Divide (/): [S1] / [S2]

•Modulus (%): [S1] % [S2]

•Primary ((,)): ([S1] * ([S2] + [S3])

Functions

•Abs: Returns the absolute value of a specified number—Abs(-1), Result: 1

•Ceiling: Returns the smallest integer greater than or equal to the specified number—Ceiling(1.5), Result: 2

•Floor: Returns the largest integer less than or equal to the specified number—Floor(1.5), Result: 1

•if: Returns a value based on a condition—if(condition, true-value, false-value) if(True, 1, 2), Result: 1