INDEX

Documentation Library

Search for information on Hornbill Documentation.

Filter

Books

All
{{book.title}}
{{book.foundCount}}

Products

{{product.name}} {{docApp.searchFilteredProducts[product.id].returnedCount}}

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

{{resultItem.title}}

{{resultItem.url}}

{{resultItem.content}}

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

{{book.title}}

{{book.title}}

More...

Measures

In order to provide strategic business intelligence through reporting, one of the key requirements is to define measures that are sampled and stored periodically. Once these measures are stored over a period of time, the type of reporting possible is expanded considerably. It includes trending, performance measurement against goals and thresholds, and predictions based on historical trends.

The creation of a Measure includes selecting the data you wish to sample, the frequency that the samples are taken, and the targets and goals you wish to achieve. The information provided by measures can be used to build Widgets for displaying on Dashboards. The output consists of numerical values that enable the population of:

Scorecards
This is a count of the data that the measure has recorded per period.
Sparklines
This is a count of the data that the measure has recorded per period shown in a chart format.
Actual vs Target
This is a count of the data recorded vs the target count of the measure per period.

Features

Basic Information

Title
The title is visible from within the list of defined measures. It is also used when creating a widget based on a measure.
Description
A details description of the measure can be provided so that other users with the ability to view and edit this measure can understand more about the measure.
Status
A “running” measure is currently active and sampling data based on the frequency.

Measure

Frequency
This is the frequency that the measure will take a data sample. The options are:
- DAILY
- WEEKLY
- MONTHLY
- QUARTERLY (Please choose the starting quarter)
- YEARLY
Value Aggregate
This is the type of calculation that the measure will perform.
- COUNT
  An integer that represents a count of items in a result set that match a specific criteria.
- AVERAGE
  A numeric value that represents the average value in a series of values in the data set.
- MIN
  A numeric value that represents the lowest value in a series of values in the data set.
- MAX
  A numeric value that represents the highest value in a series of values in the data set.
- SUM
  A numeric value that represents the sum of a series of values in the data set.
- PERCENT
  A percentage of items in a given data set that match criterion from a larger subset. For example, the count of records where column X = 5 in a set of records in a given date range, is returned as a percentage.
Scorecard Limit
This is the number of samples shown against a scorecard.
Sparkline Limit
This is the number of samples shown against a sparkline.
Maximum Sample History
This is the maximum number of samples that the system will store against this measure.

Targets & Goals

Measure Thresholds
This is the count that needs to be achieved in order to meet the measure’s target.
Warning Threshold
This is the count between the target and the breach thresholds.
Breach Threshold
This is the count that needs to be achieved in order for the measure to breach its target.

Tip

Information The direction of the threshold can be changed by clicking the arrow to the right of the threshold targets. In terms of requests or requests logged, you would want to say that the lower the number is, the better the teams are performing; however, for the total number of resolved calls, a higher count is better.

Data Source

Table
This is the primary table from which the measure will collect its data.
Key Column
This is the primary key of the named table. Being the primary key, this provides a unique identifier for each record.
Additional Tables
This is where you would specify any additional tables from which the measure will collect its data.
Date Ranging Column
Here, you select a date column that the measure will base its data collection on. The dates held in this column will be used to count/sum/average the records based on frequency, such as last month, last year or all records since the beginning of this year.
Date Ranging Column 2
This is an optional field where you can provide a second date column to be included as part of the criteria for data collection. This will be used to count/sum/average the records where the collected data for the selected frequency will be based on both Date Ranging Column AND Date Ranging Column 2.
Query where clause
This is where you can add a filter to the measure.
Percentage Sub-Query
This is where you can add a percentage filter to the measure.
Saved Data Columns
This is where you can specify which columns are available to be drilled down on and grouped by. Unless columns are defined against the measure, they will not be available to group by or drill down when configuring widget content based on the measure.

In This Document

{{docApp.title}}

{{docApp.description}}