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

Essential Success Plan

This document defines the scope of the Essential Success Plan provided by Hornbill and should be read in conjunction with the applicable Hornbill Terms of Service. The Essential Success Plan provides an essential level of support and is included as part of your subscription to the Hornbill service.

Ensuring your success

Although using Hornbill is intuitive, information to help you is available here on our docs site and also in our forums. Any issues and questions receive informal support from the Hornbill community on our Community forum.

Many members of the Hornbill team also have an active presence in the Hornbill community. In addition to your fellow Hornbill subscribers who may share their successes and challenges relating to their Hornbill solutions, our development teams, product owners, and of course our Support team all monitor the traffic and coordinate to ensure that you get the right response from the right person. If you are reporting a critical issue relating to service availability, we aim to provide a resolution within four hours and post regular progress updates to ensure the whole community is kept up to date.

Note

Some critical issues not specifically relating to problems with our cloud infrastructure may require developer support to resolve. Whilst full cradle-to-grave support for cloud infrastructure issues affecting availability is provided 24x7x365, development support is only guaranteed during normal UK business hours. Comprehensive support for all types of issues is available with the (Premier Success Plan)[https://wiki.hornbill.com/index.php].

Named support contacts

You are required to provide Hornbill with the names and email addresses of support contacts who are responsible for managing your account:

Role Description Required/Optional
Account Authority This person can authorize changes to your instance, including ones that will affect your billing. Examples include increasing subscriptions, changes to the company name, and changes in contacts. This may be your implementation lead and it may be someone with a job title like Director or Head of Procurement. Required
Technical This person is a Hornbill administrator and will engage with Hornbill Support and Customer Success. They will also be notified of any larger changes to Hornbill. Required
Data Security This person is Hornbill’s contact for any data security-issues. Typically, this person is responsible for your information security policies and practices. Required

What we need from you

Most importantly, nothing unreasonable. We need three official contacts. One of these needs to act as the named authority for affecting operational changes (e.g. new contact names). We need this because our information security policies require us to identify you before implementing changes or providing information in relation to customer/production instances. It is important that issues of a critical nature, and cloud infrastructure issues in particular, are reported by named contacts only. One of the contacts will also have primary authority over your instance.

As you should expect, we will approach critical issues with urgency. However, in order to progress them as efficiently as possible, we also need your help. Please outline your issues with as much relevant detail as possible, but also as concisely as you can. We understand that certain issues can cause a significant impact to our customers and appreciate that as a result, this may place customers under a high degree of stress. We are here to help. In order to maintain our high standards though, Hornbill needs to be able to guarantee that its staff are able to work in an environment that is free from obstruction to do so.

Appendix 1: Definitions

Terms in this section have the same meanings as those given to them in the Hornbill Terms of Service unless other meanings are given to them below. In these terms, unless the context otherwise requires, the following words and expressions mean:

  • Available: The SaaS Service is accessible by the majority of the Customer Users, functioning substantially in accordance with any applicable product manuals. Note that if the SaaS service is not available to any or all Customer Users owing to a fault or condition outside of Hornbill’s control, such as, but not limited to a failure of the Internet, then it shall still be deemed Available.
  • Availability Service Credits: Credits of Subscription Fees paid by Customer as a result of a failure of the SaaS Service to meet the SaaS Service Availability.
  • Business Hours: The number of hours elapsed during normal UK business hours 09:00 through 17:30 UK time Monday to Friday excluding UK public holidays.
  • Critical Issue: A failure in the production operation of the service rendering the service unavailable or critically impaired. Alternatively, there might be a significant security issue or availability affected by corrupted data.
  • Maintenance Notice Service Level: The minimum advanced notice period for a maintenance activity to be classified as Works is seven elapsed days (168 elapsed hours) for routine and/or planned activities and four elapsed hours for high-priority activities as solely determined by Hornbill.
  • SaaS Service Availability: The calculation of service availability for the purposes of calculating Service Credits.
  • Service Available Hours: The amount of time the SaaS Service is Available according to the service level. Calculated as the Service Operational Hours minus the time the SaaS Service is not Available (other than due to Works).
  • Service Maintenance Hours: The four (4) hours from 00.00 to 04.00 each day (with reference to the timezone defined in the Service Parameters) during which Customer access to the SaaS Service may be interrupted by the carrying out of Works.
  • Service Operational Hours: In any given period the total hours minus the time spent on Works (specifically when the SaaS Service is not Available).
  • Works: Routine and/or planned maintenance activities or high-priority activities (that interrupt the SaaS Service) as is required by professional computing practice and that take place during the Service Maintenance Hours and as communicated to Customer in accordance with the Maintenance Notice Service Level.

Appendix 2: Availability Service Levels and Service Credits

  • Availability: For the purposes of service reporting and calculation of any applicable Availability Service Credits, SaaS Service Availability for any period is expressed as a percentage and calculated as the Service Available Hours for the period divided by the Service Operational Hours.
  • Data Loss: Hornbill takes reasonable steps to secure the Customer Data against loss due to any single system failure. Should Customer Data be lost due to such failure it will attempt to restore the data to a point prior to its loss. The maximum amount of time for which data should be lost is specified as one of the Service Parameters. Once the data has been restored by Hornbill using reasonable efforts, any resultant data loss shall not in its own right constitute service unavailability.
  • Service Credits: Availability Service Credits are calculated on a monthly basis as a percentage of the Subscription Fee where the SaaS Service Availability falls below a certain threshold as shown in the Schedule below. To be entitled to any Service Credits, the Customer must request such Service Credit in writing from Hornbill within 30 days of the relevant month. The Service Credit will be applied to the next Subscription Fee invoice to be raised. If the Subscription Period has been reached (and no further invoice is to be raised) then no Service Credit is applied.

Schedule for Availability Thresholds

Availability in Subscription Period Service Credit (as a percentage of Subscription Fee)
Greater than 99.95% 0%
Between 99.94% and 98.95% 2.5%
Between 98.94% and 97.95% 5%
Between 97.94% and 96.95% 10%
Less than 96.95% 20%
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document