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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

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

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Complex Types - scorecardDataMeasureType

  • Article
  • 1 minutes to read

Description

score card dataset based on a measure

Properties

Name Type Occurrence Description
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
frequency xs:string Optional The frequency label if the option to show it is set i.e. sample taken every month
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
measureId xs:integer Required The id of the measure (can be used when doing drilldowns
measureTrendData measureTrendData Optional Trend data in more detail
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
target xs:decimal Optional the target value that needs to be achieved for measure. Only return if option to show is set
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
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document