1. Administration Guide
  2. Appendix: Report Data Requirements
  3. BI Response Layout

BI Response Layout

This section defines various response layouts that will be referenced in the following section when describing required response analyses for each report.

BI Simple Metric

Column Property Type Required Description

0

Metric Name

String

Y

Name of the metric.

1

Metric Value

Number

Y

Value of the metric.

2

Value Format

String

N

Format for the value. The following formats are supported:

  • PC - Percent (.01 = 1%)

  • S - Short (1000 = 1K)

  • N - Number (1000 = 1,000)

3

Value Label

String

N

An additional label to display below the value.

BI Metric

Column Property Type Required Description

0

Metric Name

String

Y

Name of the metric.

1

Metric Value

Number

Y

Value of the metric.

2

Value Format

String

N

Format for the value. The following formats are supported:

  • PC - Percent (.01 = 1%)

  • S - Short (1000 = 1K)

  • N - Number (1000 = 1,000)

3

Value Label

String

N

An additional label to display below the value

4

Indicator

String

N

An indicator to display next to the value. The supported options are "up", "down", "normal", "info", "important", and "critical".

BI Metric Chart Config

Column Property Type Required Description

0

Chart Type

String

Y

Type of chart to display: "line", "bar", "area", or "total"

1

Chart Title

String

N

Title to display above chart

2

Render Tooltips

Boolean

N

Hide or show tooltips on the chart. Default true.

3

Series Name

String

N

Label displayed in tooltip. Applies to line, bar, and area charts.

4

Value Format

String

N

Formats the output of values in the chart. Takes the same values as for metrics items.

5

Value Label

String

N

Prefix for values. Applies to total charts only.

6

Value Units

String

N

Suffix for values. Applies to total charts only.

7

X-Axis Title

String

N

Label for the X-axis. Applies to line, bar, and area charts.

8

Render X-Axis Labels

Boolean

N

Show or hide tick labels on the X-axis. Applies to line, bar, and area charts.

9

Y-Axis Title

String

N

Label for the Y-axis. Applies to line, bar, and area charts.

10

Render Y-Axis Labels

Boolean

N

Show or hide tick labels on the Y-axis. Applies to line, bar, and area charts.

11

Initial Scrolling Position

String

N

Which end of the chart to start at if there are too many items to show at once. Options are "first" and "last", defaults to "first". Applies to line, bar, and area charts.

BI Metric Chart Item

Each BI Metric Chart Item represents a value displayed in a chart (bar, line, area, total).

Column Property Type Required Description

0

Item Value

Number

Y

Value of the item.

1

Item Name

String

Y

Name of the item.

2

Item Series

String

Y

Series Name of the item.

BI Table Config

Column Property Type Required Description

0

Report Name

String

Y

Name of the report.

1

Image Column Header Label

String

N

Column header label for images.

2

Descriptor 1 Name

String

Y

Column header label for first descriptor.

3

Descriptor 2 Name

String

N

Column header label for second descriptor.

4

Metric 1 Name

String

Y

Column header label for first metric.

5

Metric 1 Value Format Code

String

Y

Value format code for first metric.

6

Metric 1 Max Threshold

Number

N

Metric 1 values greater than the Metric 1 Max Threshold value will be displayed in Green.

7

Metric 1 Min Threshold

Number

N

Metric 1 values less than the Metric 1 Min Threshold value will be displayed in Red.

8

Metric 2 Name

String

Y

Column header label for second metric.

9

Metric 2 Value Format Code

String

Y

Value format code for second metric.

10

Metric 2 Max Threshold

Number

N

Metric 2 values greater than the Metric 2 Max Threshold value will be displayed in Green.

11

Metric 2 Min Threshold

Number

N

Metric 2 values less than the Metric 2 Min Threshold value will be displayed in Red.

12

Metric 3 Name

String

Y

Column header label for third metric.

13

Metric 3 Value Format Code

String

Y

Value format code for third metric.

14

Metric 3 Max Threshold

Number

N

Metric 3 values greater than the Metric 3 Max Threshold value will be displayed in Green.

15

Metric 3 Min Threshold

Number

N

Metric 3 values less than the Metric 3 Min Threshold value will be displayed in Red.

BI Table Item

Column Property Type Required Description

0

Image URL

String

N

URL of image to display

1

Descriptor 1 Value

String

Y

Value for first descriptor.

2

Descriptor 2 Value

String

N

Value for second descriptor.

3

Metric 1 Value

Number

Y

Value for first metric.

4

Metric 2 Value

Number

N

Value for second metric.

5

Metric 3 Value

Number

N

Value for third metric.

BI Report Analyses

This section describes the required analyses for each report and will reference the BI Response Layout above for details.

BI Two Metric Report

This category includes the following report template:

  • BI Two Metric Summary

Table A-3 Required Analysis

Template Parameter Response Layout Repeat within row Rows Columns

BI Analysis Catalog Location

BI Simple Metric

up to 2

1

4 to 8

BI Twelve Metric Report

This category includes the following report template:

  • BI Two Metric Summary

Table A-4 Required Analysis

Template Parameter Response Layout Repeat within row Rows Columns

BI Analysis Catalog Location

BI Metric

Up to 12

1

5 to 6

BI Metric Chart Reports

This category includes the following report templates:

  • BI Four Metric with Chart Template

  • BI Six Metric with Chart Template

Table A-5 Required Analyses

Template Parameter Response Layout Repeat within row Rows Columns

BI Metrics Analysis Catalog Location

BI Metric

up to 4/6

1

5 to 20/30

BI Chart Configuration Analysis Catalog Location

BI Metric Chart Config

No

1

13

BI Chart Items Analysis Catalog Location

BI Metric Chart Item

No

Many

2

BI Table Reports

This category includes the following report templates:

  • BI Metrics Table Template

  • BI Image Table Template

  • BI Image Metrics Template

Table A-6 Required Analyses

Template Parameter Response Layout Repeat within row Rows Columns

BI Table Headers Analysis Catalog Location

BI Table Config

No

1

up to 16

BI Table Items Analysis Catalog Location

BI Table Item

No

Many

up to 6

Note:

All the report templates listed above require the same analyses using the same column layout, but some columns are not used in some reports. The BI Metrics Table Template will ignore the image related columns. The BI Image Table Template will ignore the values and configuration for the second and third metrics. If ignored columns are at the end of the row (such as metrics) they can be left out of the response.