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

Widgets

Widgets are provided to create plug in data that can be used to build Dashboards. Some widget types make use of existing measures and provide the ability to display them in a more appealing format. Certain widget types allow you to return and display data based on configuration carried out within the widget.

General Settings

Data Chart Widgets

When creating Data Charts it is possible to define how the data for the chart will be created using the following options:

  • Measured Sample
    This type allows you to add multiple measures data to a single chart, and to display the data using definable sample intervals, and history.
  • Measured Group By
    This type allows a single measures data to be displayed and grouped by Saved Data Columns.
  • Measure Samples Group By
    This type allows a single measures sampled data to be grouped and displayed by Saved Data Columns and by definable sample periods (manual or predefined date settings).
  • Sql Group By
    This type allows you to specify a database table, which column to group on, which to count on as well as define filter conditions for the data, and the sample history duration.

Scorecard

A Scorecard widget can be used to display one or more Measures which have previously been defined.

Target Counter

This type of widget is used to display how a single measure is performing against it’s target.

List of Data

Allows you to populate a widget with a list of data based on a user defined table query.

List of Counters

This widget allows you to display one or a list of metrics that are based on an aggregate value such as count, average, max, and min.

Custom

The custom widget type allows you to specify a URL and display the content as an image, in an iframe or div.

Pre-Defined Date Settings

When creating widgets within Hornbil Advanced Analytics, some widget types provide the ability to set the sampling type and the sampling period. The sample period when using predefined date settings consist of multiple options to provide you the flexibility to set the widget to report on a specific period in time. Some of these options relate to the beginning of a week (this week or last week), and because the week start day can be different for organizations based in different countries Hornbill have also provided a setting to enable this to be set per Hornbill instance within the System -> Settings -> Advanced section from your Hornbill admin portal. Search for system.regionalSettings.weekStartDay to set it for your instance. By default this setting is set to Sunday as the start of the week. There are also settings for the beginning of the calendar year - reporting.calendarYearStart which by default is set to 01/01, and a setting for the beginning of the financial year - reporting.financialYearStart which by default is set to 01/04.

The pre-defined date settings are explained here:

Date Setting Definition
Start Of This Week 00:00:00 hours on the last Sunday before today
Start Of This Month 00:00:00 hours on the first day of the current month
Start Of Financial Year 0:00:00 hours on the first day of the current financial year
Start Of This Year 00:00:00 hours on the first day of the current year
Start Of Calendar Quarter 00:00:00 hours on the first day of the current quarter. A quarter can start in January, April, July or October
Start Of Financial Quarter 00:00:00 hours on the first day of the current financial quarter. A quarter can start in January, April, July or October
Start Of Last Week 00:00:00 hours on last week’s Sunday
Start Of Last Month 00:00:00 hours on the first day of the last month
Start Of Last Financial Year 00:00:00 hours on the first day of the last financial year
Start Of Last Year 00:00:00 hours on the first day of the last year
Start Of Last Calendar Quarter 00:00:00 hours on the first day of the last quarter
Start Of Financial Quarter 00:00:00 hours on the first day of the last financial quarter
Last Calendar Years Samples 00:00:00 hours on the first day of the last year to 23:59:59 hours on the last day of last year
Last Financial Years Samples 00:00:00 hours on the first day of the last financial year to 23:59:59 hours on the last day of last financial year
Last Calendar Quarter Samples 00:00:00 hours on the first day of the last quarter to 23:59:59 hours on the last day of the last quarter. A quarter can end in March, June, September or December
Last Financial Quarter Samples 00:00:00 hours on the first day of the last financial quarter to 23:59:59 hours on the last day of the last financial quarter. A quarter can end in March, June, September or December
Last Months Samples 00:00:00 hours on the first day of last month to 23:59:59 hours on the last day of last month
Last Weeks Samples 00:00:00 hours on last week’s Sunday to 23:59:59 hours on last week’s Saturday
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document