Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - widgetScorecardGroupByDefinition

  • Article
  • 1 minutes to read

Description

Scorecard widget that runs off 1 or more data measures.

Properties

Name Type Occurrence Description
measureId xs:integer Required The id of the measure to load and seperate into mini measures
groupByColumn xs:string Required the sample column to seperate the measure by
orderDirection orderDirectionType Optional show top or bottom matching records i.e. asc/desc
showFrequency xs:boolean Required
Default=true		 show the frequency label i.e. sample taken every month
showScoreboard xs:boolean Required
Default=true		 show the score board indicator
showTrendLine xs:boolean Required
Default=false		 show the trend line for the measure. Default false
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
showTarget xs:boolean Required
Default=true		 show the target value that needs to be achieved
showCurrentSample xs:boolean Required
Default=true		 show the current sample value
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
showTargetIndicatorDirection xs:boolean Required
Default=true		 show the target indicator (up, down or static movement)
dataFormatter xs:string Optional apply format to measure sample data. See the type widgetDataFormatterType for the expected values
scorecardMetaData xs:string Optional Json meta data for extensibility.
periodFilter samplePeriodFilterType Optional Restrict the samples within this date time range
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document