Group components

Group components summarize content by one or more fields from your data source. Based on a filter, they retrieve the result set and group by a field, providing a summary of your data rather than the full results. Group components are not dependent on date or time, so you can display them with or without date and time filters. If filters are absent, all data within that group is displayed from the data source.

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

Within a single group component, you can have multiple independent series, each retrieved from a different 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.

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 group-component format.

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

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

2.The Group Component dialog displays the following options:

•General tab

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

•Series: A series list defined for the component. The Group Component Series dialog explains how to interact with any one series. For details, see the section below.

•Output tab

•View: Display method for the series (pie, doughnut, and so on).

•Sort: Sort order for the summarized data. The value is applied to the primary series.

•Count: Number of records to display; an option is to select All. If you expect the result set to include many rows, Count enables you to limit the number to a manageable subset. 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.

•X axis label: Label displayed on the X axis, if applicable.

•Y axis label: Label displayed on the Y axis, if applicable.

•Y axis range: Use a specified range for the Y axis rather than the default automatic range.

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

•Show other: Select to list all records outside your count separately under a label of "Other *."

•Show legend: Select to display a legend that substitutes for values within a pie, doughnut, or bubble chart.

•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 value: Select if the summary values should be visible.

•Show percent (series): If selected, a percentage is calculated based on the data across the series.

•Bubble tab

•X axis series: Series to use for the X axis in a bubble-chart view.

•Y axis series: Series to use for the Y axis in a bubble-chart view.

•Radius series: Series to use for the radius size in a bubble-chart view.

•Colors tab

•Add a text description and color to use in the results triggered by values within the data. Right-click in the columns area and select Add color to enter a value (which is text describing the results) and color. For example, if your data contains the summarized value "Very High," you can define the output to display in red for these values.

•Lines tab

•Add one or more fixed lines of text to display across any of the group-component formats indicating when data exceeds a value. Right-click in the columns area and select Add line to enter the text, a value, and a color. For example, you can enter "Very High" for the text with a value of "100" and select the color red to visually show when data exceeds that value.

•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.

Group-component series

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

To sort the order of more than one series displayed in the list, use the icon to drag and drop items up/down the list.

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

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

•General tab

•Title: Title for the group series.

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

•Data source: Data source used for this series.

•Group field: The data-source field on which data is to be summed.

•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.

•Color: Color to use for the series.

•Show value: Select to display summarized data values.

•Show percent: Select to display summarized data percentages.

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

•Export chart labels: Select from default, on, or off to show labels for each data point appearing on exported chart graphs.

•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.

•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.

Calculated series

A calculated series enables you to create a new series for the group 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 Group Component dialog > General tab > Series area, right-click and select Add calculated series.

2.The Group 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 that calculates 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 used when displaying numeric values.

•Color: Color to use for the series.

•Visible: Select if you want the series to be visible in output. If yo want to hide any series used in the calculation, clear this option.

•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