Callout adjustments provide users with fine-grained control of how totals, averages, and percent differences are calculated in cards, and help determine how data gaps are handled.
👍 This article will help you:
Understand the fundamentals of callout adjustments
Learn how to use callout adjustments to fine-tune calculations in cards
Callout adjustments only affect the callout values at the bottom of cards, not the data displayed in the graph.
Where are callout adjustments available?
Callout adjustments are available for the following cards with callout sets. A callout set may be automatically selected based on the selected Overlay.
Card | Callout Sets |
Portfolio Trends | Total this period, Total previous period, Difference |
Portfolio Year-over-Year Trends | Total year period 1, Total year period 2, Difference |
Building Trends | Total this period, Total previous period, Difference |
Building Year-over-Year Trends | Total year period 1, Total year period 2, Difference |
Building Comparisons | Total this period, Total previous period, Difference |
Building Readout | Total this period, Total previous period, Difference |
How do callout adjustments work?
The following selections are available for callout adjustments.
Period start
Selection | Description |
At period start date | Start date will be determined by the start date of the main period. |
At first available data | Start date will be determined by the first hour, day, month, or year with data in the main period or comparison period. |
Period end
Selection | Description |
At period end date | End date will be determined by the end date of the main period. |
At last available data | End date will be determined by the last hour, day, month, or year with data in the main period or comparison period. |
At "now" | End date will be determined by where now is in the main period. |
Period data gaps
Selection | Description |
Include missing segments | All available data in the main period and comparison period between Period start and Period end will be included. |
Exclude missing segments | Any missing segments in the main period or comparison period between Period start and Period end will be excluded. |
Adjustments method
Selection | Description |
Unidirectional | Any adjustments to the main period (period start, period end, period data gaps) will be applied to corresponding segments of the comparison period. |
Bidirectional | Any adjustments to the main period (period start, period end, period data gaps) will be applied to corresponding segments of the comparison period. |
🚧 Special considerations for portfolio-scope cards
Portfolio-scope cards, as well as building-scope cards that aggregate many points (where Point type = 'Total energy' or 'All point types'), do not apply any callout adjustments by default.
If Period start = At first available data, then the card will detect the first month (or hour, day, or year) of complete data for all 'Whole building' points of the selected point type.
If Period end = At last available data, then the card will detect the last month (or hour, day, or year) of complete data for all 'Whole building' points of the selected point type.
If Period data gaps = Exclude missing segments, then any missing segments across all 'Whole building' points of the selected point type will be excluded.
Example
Let's say today is Sep 15, 2018, and you've created a Building Trends card comparing this year (2018) to last year (2017). The selected callout set is Total this period, Total previous period, Difference, which defaults to the following selections:
The callouts will be adjusted based on this graphical depiction of the main period (2018) and comparison period (2017):
Above: In this example, blue represents available data, orange represents period start and period end, and "X" represents excluded segments.
Period start = At period start date
The period start date of the main period is Jan 1, 2018. Period start also informs the start date of the comparison period, Jan 1, 2017.
Period end = At last available data
The period end date of the main period is Dec 31, 2018, and today is Sep 15, 2018, but the last available data is Aug 8, 2018. Period end also informs the end date of the comparison period, Aug 8, 2017.
Period data gaps = Include missing segments
All available data in the main period and comparison period between Period start and Period end are included in the calculations (main period: Jan 1 - Aug 8, 2018; comparison period: Jan 1 - Aug 8, 2017). This means the missing data at the beginning of the comparison period (2017) is included.
Adjustments method = Bidirectional
Since missing segments are included, only period-adjusted segments of the main period or comparison period are excluded, as well as corresponding segments of the other period. This means the segment between Aug 8 - Dec 31, 2018 in the main period, which has yet to elapse, results in the exclusion of Aug 8 - Dec 31, 2017 in the comparison period.
Troubleshooting
Problem | Solution |
No data appear in the callouts, even when the graph has data. | This likely means that there are missing data within the main period or comparison period affecting the calculation. In a portfolio-scope card, verify that all 'Whole building' points of the selected point type have complete data. |