INDEX

Documentation Library

Search for information on Hornbill Documentation.

Filter

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.

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.

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.

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.

More...

Defines how to get data for a chart measure group by.

Name	Type	Occurrence	Description
`filter`	`xs:string`	Optional	where caluse filter to restrict the selection. NOTE: Currently this filter will not work as drill down data columns are different from original columns and filters are expressed in original columns. Though we have mapping from original columns to drill down columns, but due to arbitrary complexity of filters its difficult to translate filter meant for original table to drill down table. Unless we restrict the filter language. (Work in progress)
`measureId`	`xs:integer`	Required	measure id to use for data series
`periodFilter`	samplePeriodFilterType	Optional	Restrict the samples within this date time range
`sample`	`xs:integer`	Optional	number of rows to return. if not specified return all
`show`	orderDirectionType	Optional	show top or bottom matching records i.e. asc/desc
`tickType`	sampleFrequencyPeriodType	Optional	Frequency with which to re sample the measure data, if auto originally measured data is returned

In This Document