1. Home
  2. Custom Report Builder – G01 Line Graph Widget

Custom Report Builder – G01 Line Graph Widget

1.1 Widget Setting

1.1.1 Data Tab

1.1.1.1 Preview

  1.  Dimensions
    1. A list of dimensions. Users are able to drag the dimension to the Filter or Split area to render out the result for the graph.
  2. Measures
    1. A list of metrics. Measures are the values that will be aggregated over the selected data. Users are able to drag the metric to the Measure area to select the metric for the widget.
    2. The naming structure of measure: [Metric Code]_[Count Mode]_[Aggregation Formula] (e.g. FC01_1_Sum)
    3. For metric code definition, please refer to Appendix B - Metrics Definition
    4. The following count mode stand for:
      1. 1 - People,
      2. 11 - Visitor People,
      3. 21 - Staff People,
      4. 12 - Car Vehicle
  3. Filter
    1. Users are able to select the dimension to filter (WHERE clauses) the data for the graph. By default, the filter will follow the report granularity to preselect a few dimensions. (e.g. Company level report will auto filter with latest date, company id and company name). If users drag a non-preselected dimension (e.g. Area), this widget will become data binded and the graph output will follow the selected option of the dimensions.
    2. Filter Configuration:
      Item Description
      1. Time

      • Default filter date range based on the widget time interval.
        • Minutes, 15Minutes, Hours - Latest Day
        • Days - Latest Week
        • Weeks - Latest Month
        • Months, Quarter, Year - Latest Year
      • Users are able to select the data range to preview the graph output. If user select relative time, the selected time will not apply to the real data for the graph to display (only for preview display purpose). If user select fixed time, the selected time will apply to the real data for the graph to display
      • Time Shift - Users are able to compare a timeframe with a previous one. Users are able to define a shift interval such as last day, last week, last month or other ISO_8601 Duration Expressions (e.g. PT1H for one hour, P1Y for one year).
      2. Data
      • Users are able to select for the dimension options to preview the graph output. If there are extra filters (not preselect dimensions), this widget will be considered as data binded.
      • For example, if the selected granularity of the report/dashboard is Site, the preselected dimension will be Company and Branch. If users drag a non-preselected dimension (e.g. Area), this widget will become data binded and the graph output will follow the selected option of the dimensions.
  4. Split
    1. Users are able to select the dimension to split (GROUP BY clauses) the data for the graph. The maximum split for G01 line graph widget are two dimensions and must have a Time dimension, which are Time or  Data + Time.
    2. Split Configuration:
      Item Description
      1. Granularity (Only Supported for Time Dimension)
      • Time - Time Granularity based on the widget's time interval.
      • Time2 - Users are able to select the granularity for Time, which are minute, hour, day, week, or month.
      2. Sort By Sort according to the selected option.
      3. Order By Order by ascending or descending.
      3. Limits Select the output limit (5, 10, 25, 50 or 100).
  5. Measure
    1. Users are able to select the measure to render the data for the graph.
  6. Element Type
    1. Preview the result in different element types (only for preview display purpose).
  7. Preview Screen 
    1. Users are able to preview the graph output in different element types based on the selected dimensions and measure in filter section, split section and measure section.

1.1.1.2 Preview Table

Users are able to configure the display name of the X-axis and Y- axis for the graph. By default, the display name will follow the default name of the selected dimensions/measures.

 

1.1.2 Settings Tab

Item Description
1. Chart Title* Title for the table (Maximum 30 characters)
2. Export Name* Export name of the widget for the export function

*Required field

1.1.3 Advanced Tab

Item Description
1. Enable Single Y- Axis Check this checkbox to display multiple Y-axis as a single Y-axis. Only applicable for measures that have same data format
2. Show YTD Check this checkbox if the graph need to display date according to the period of the time beginning the first day of the current calendar year or financial year up to the current date
3. YTD Option Select the Year to date(YTD) format. By default, Calendar Year will be selected. Calendar year is a one-year period that begins on 1st of January and ends on 31st of December. Financial year is a one-year period that begins on the start date of the financial year as configured in the company settings
4. Line/Band Indicator

Note: Before configure line or band indicator, make sure the measure/metric selected for this widget has a metric definition and metric threshold value.

Line indicator

  • Indicator - Line indicator is a plot line which indicate the selected threshold value on the graph.
  • Color - User may select the color of the plot line to display on the graph.
  • Set Widget Specific Threshold - Check this checkbox if users want to set a specific threshold value of the plot line for this widget. Enter the specific threshold value on the text area.
  • Threshold Selector - Select the metric definition which the threshold value should obtain from.

Band indicator

  • Indicator - Band indicator is a plot band which indicate the selected threshold value on the graph.
  • Band Label - Naming of the plot band which will be display on the graph.
  • Color - User may select the color of the plot band to display on the graph.
  • Range of Plotband 
    1. Greater than a threshold - The plot band with the selected color will display above the selected threshold value
    2. Range of values - The plot band with the selected color will display between the selected threshold values. The upper limit and lower limit threshold value cannot be the same.
    3. Lower than a threshold - The plot band with the selected color will display below the selected threshold value.
  • Set Widget Specific Threshold - Check this checkbox if users want to set a specific threshold value of the plot band for this widget. Enter the specific threshold value on the text area.

  • Threshold Selector - Select the metric threshold definition which the threshold value should obtain from

5. SSI (Optional) Apply custom SSI code by selecting the SSI template or enter the code in the text area.

Updated on January 27, 2022