Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

As of 4.3.2. release, we are introducing Gauge control as This control is a part of Free Format Template. This control Report and allows to analyze the company's KPI values as opposed to the defined target values. For instance, you may want to compare your actuals to the budget values, or previous month performance or peer performance. Please, refer to the Gauge Control article for detailed information.

Parameters

Settings

The report parameters settings define the look & feel of a report:

CONTENT

Table of Contents

Image RemovedImage RemovedImage AddedImage Added

Basic

Control Parameters

Parameter

Setting

Description

Mandatory

1.

Data Source

Select the list containing the gauge sections

Yes

2. Title

 Title of the Gauge Chart Control

No

Advanced Control Parameters


Parameter

Labels, Formats and Colors


Setting

Description

Mandatory

3. External Item Selector

An external control which will be used as an item selector for this control

No

4. Gauge radius

Indicates outer radius of the Gauge. Use 0 for auto size

Yes

5. Scale radius

Indicates the radius of the scale. Use 0 for auto size

Yes

6. Number of intervals

Determines number of major intervals on the gauge chart.

Yes

7.

Title

Title of the Gauge Chart Control

No

Chart format

A format can be chosen from the /wiki/spaces/CXO/pages/2806776298 list. This Format relates to the colors of the gauge elements: needle, numbers, background. Specify "Fore Color" for the numbers, "Back Color" for the needle, "Chart Series Color" for the background, "Chart Shape Color" for the background additional color. If you want to have a monocolor background, set "Chart Series Color" and "Chart Shape Color" to the same color

.

Yes

8. Range distance from scale

Determines the distance between the scale and the ranges

Yes

9

.

Half-CircleAllows to use a full or half-circle as gauge chart

Yes

10.

Scale

This defines the /wiki/spaces/CXO/pages/2806776400 used in the report. It can be overruled by the scaling in the Lists.

Yes

11.

Precision

Defines the number of decimals used for presenting the number. Options are 0-6. Similar to the Scale setting, The Precision setting is the default for all data in the report, but can be overruled by a specific (not -1) precision in the List.

Yes


Layout

Setting

Description

Mandatory

Gauge radius

Indicates outer radius of the Gauge. Use 0 for auto size

Yes

Scale radius

Indicates the radius of the scale. Use 0 for auto size

Yes

Scale ModeWhether Scale mode is Auto or ManualYes

Number of intervals

Determines number of major intervals on the gauge chart.

Yes

Range distance from scale

Determines the distance between the scale and the ranges

Yes

Half-Circle

Allows to use a full or half-circle as gauge chart

Yes

How to create a Gauge Chart

The behavior of the Gauge chart is defined by the list, used in the Data Source Parameter.

You can create a Gauge chart with the fixed values or a dynamic chart, which will change the behavior based on the item, picked from the related Item Selector (see External Item Selector report parameter).

Example

1

Let’s first consider a simple Let's consider an example of a Gauge chart for a single fixed KPI.
We will build a report, which will allow to see if the company has reached the target value (Budget) for the Gross Margin.First, we need to create a dynamic report, which will allow to pick different accounts for the Gauge chart.

To achieve this we will combine a Gauge chart with an External Item Selector Control, also available in the Free Format Report.


1. First we will include several accounts in a List, which will be used in the Item selector:

Image Added

2. Then we will create the list, which will be used as a Gauge Data Source:

The dimensions to

. Only Category dimension will be included in the list

are: Account and Category
  • The first item in the list represents the actual value of Gross Margin
  • The second item is the starting point for the chart – in this case it is zero and a multiplication by zero is used in the formula
    #The third item represents a negative range – a multiplication formula is used (Budget value *

    , as the account value will be defined by the Item Selector.

    The list will be used to determine the Gauge look and feel. For each row item a fixed representation is set to reflect Gauge behaviour:

    1. The first row represents the needle
    2. The second row represents the start of the Gauge, in this case zerro (Mulplied by 0)
    3. The third row represents a negative range, in this case the end of the red line (Budget multiplied by 0.9)
    4. The fourth item row represents a neutral range – equals Budget value
      #The , in this case the end of orange line (Budget values)
    5. The fifth item represents a positive range – a multiplication formula is used (Budget value *, in this case the end of the green line (Budget multiplied by 2)

    To define the colors of the Gauge ranges Maintain Formats menu is special formats are used.

    You need to create a these special Format formats for every range, specifying the Chart Series Color and Chart Line Width (See table above "Chart format").
    After creating the formats, apply them to the items in the Gauge Source list.

    As a result, the Gauge Data Source list should look as follows:

    Panel

    Image Removed

    After applying the list as a Data Source for the chart, fine tune the Report Parameters:

    1. Set the Data Source to the list, created initially

    2. Set the title to "Gross Margin" (the title will appear inside the Gauge chart)

    3. Set Half-Circle parameter to Yes, so that the chart is displayed in the shape of a half-circle

    In the end, we will get the Gauge Chart which displays the Gross Margin value compared to the set targets:

    Image Removed

    Example 2

    Now let's consider an example of a dynamic report, which will allow to pick different accounts for the Gauge chart.

    To achieve this we will combine a Gauge chart with an External Item Selector Control, also available in the Free Format Template.

    1. First we will create a list to be used as an Item Selector and include there several accounts:

    Image Removed

    2. Then we will create the list, which will be used as a Gauge Data Source. Only Category dimension will be included in the list, as the account value will be defined by the Item Selector.

    The ranges for the Gauge chart are defined the same way as in Example 1:

    Image Removed

    3. Now define the following Report Parameters:

    • Set the External Item Selector parameter to Item Selector
    • Set the Item Selector parameter to the list from Step 1
    • Set the Data Source parameter to the list from Step 2
    • Set the Half-Circle parameter to Yes

    Image Added


    3. Now define the following Report Setting:

    • Set a report title
    • Set the Half-Circle Setting to Yes


    4. At last step, attach the item selector to the gauge.

    Select "Edit Layout" and for the Gauga item set "Listen To" item selector.


    As a result, we will get the following Gauge Chart which display the values for any account, picked from the Item Selector:

    Image RemovedImage Added


    See Also

    Free Format TemplateReport