Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Complex Types - widgetChartDataSeriesTimeSeries


Defines how to get time series type of data for a chart data series.


Name Type Occurrence Description
aggregate aggregationType Optional
Aggregate function to apply.
aggregateColumn xs:string Optional column to apply aggregate function on. No need to specify it if aggregation function is ‘COUNT’ Currently only functions on numeric type columns are supported. supplying non-numeric types may result in unpredictable behavior.
cascade xs:boolean Optional
Does the frequency cascades down from the top level date time construct.(year). For e.g Monthly frequency with cascade=“true” will give aggregation for each month,year combination but Monthly frequency with cascade=“false” can only give max 12 aggregations. One for each month, same months for different years are aggreagated into one
dateTimeColumn xs:string Required dateTime column to group on and build time series
drilldownColumns xs:string Optional comma seperated columns to select when doing drilldown
filter xs:string Optional where caluse filter
fromTable xs:string Required select from table
periodFilter samplePeriodFilterType Optional Specify this to restrict samples from a given time range
sample xs:integer Required number of rows to return
show orderDirectionType Required show in ascending/descending order
tickType sampleFrequencyPeriodType Optional Frequency with which to sample the time series
In This Document