Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Complex Types - widgetScorecardGroupByDefinition

Description

Scorecard widget that runs off 1 or more data measures.

Properties

Name Type Occurrence Description
dataFormatter xs:string Optional apply format to measure sample data. See the type widgetDataFormatterType for the expected values
getTrendData xs:boolean Optional
Default=true
Gets the detailed trend data, which includes the measured value, sampleIds and the range over which it was computed
groupByColumn xs:string Required the sample column to seperate the measure by
measureId xs:integer Required The id of the measure to load and seperate into mini measures
orderDirection orderDirectionType Optional show top or bottom matching records i.e. asc/desc
periodFilter samplePeriodFilterType Optional Restrict the samples within this date time range
scorecardMetaData xs:string Optional Json meta data for extensibility.
showCurrentSample xs:boolean Required
Default=true
show the current sample value
showFrequency xs:boolean Required
Default=true
show the frequency label i.e. sample taken every month
showPreviousSample xs:boolean Required
Default=false
show the previous sample value
showPreviousSampleDifference xs:boolean Required
Default=true
show the difference between current and previous sample values
showScoreboard xs:boolean Required
Default=true
show the score board indicator
showTarget xs:boolean Required
Default=true
show the target value that needs to be achieved
showTargetIndicatorDirection xs:boolean Required
Default=true
show the target indicator (up, down or static movement)
showTrendLine xs:boolean Required
Default=false
show the trend line for the measure. Default false
In This Document