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 - scorecardDataMeasureType

  • Article
  • 1 minutes to read

Description

score card dataset based on a measure

Properties

Name Type Occurrence Description
measureId xs:integer Required The id of the measure (can be used when doing drilldowns
title xs:string Required The label for the associated measure i.e. Logged Calls Per Month
trendData xs:string Optional comma seperated list of data based on the sample limit of the scoreboard measure. Only return if showtrendline or show screboard options are set in widget def, This is DEPRECATED and should not be used, USE measureTrendData INSTEAD
measureTrendData measureTrendData Optional Trend data in more detail
frequency xs:string Optional The frequency label if the option to show it is set i.e. sample taken every month
target xs:decimal Optional the target value that needs to be achieved for measure. Only return if option to show is set
currentSample xs:decimal Optional the current sample value. only return if setting to show it is set. This is DEPRECATED and should not be used, USE currentSampleData INSTEAD
currentSampleData measureTrendValueType Required the current sample data
previousSample xs:decimal Optional the previous sample value if option is set in widget def. This is DEPRECATED and should not be used, USE previousSampleData INSTEAD
previousSampleData measureTrendValueType Required Previous sample data.
previousSampleDifference xs:decimal Optional The difference between current and previous sample value. Only return if option in widget def is set to true
measureConfig measureListItemType Optional The config information associated with this measure. Not all values will be populated in this data structure. Only the config information, which is required by the scorecard widget
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document