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

Advanced System Settings

The Advanced Settings provides access to all of the available settings within your instance. These offer a number of detailed configuration options to configure your instance just the way that you want it. Some of these settings can also be managed from within other areas of the Administration interface or from the Hornbill Client. Before changing a setting it is important to understand how the setting is used in order to prevent any disruption on your instance.

Advanced List

  • Filter
    The filter allow you to find a particular setting by entering part or all of the name of the setting you are looking for.
  • Categories
    The Settings are separated into distinct areas. Using the Category Selector you can view settings that are associated to one of these areas.
  • Show Only Modified Settings
    Each Setting is provided with a default value. The option to Show Only Modified Settings allows you to quickly see all settings that have been changed from their default value.
  • Show Read-only Settings
    Some settings cannot be changed and are there for informational purposes only. Checking this option will include these settings within the main list. Read-only settings can be identified by their No Entry icon.
  • Revert to Default
    A Revert icon is visible on the right hand side of each setting that has been changed from its original default value. Clicking on this icon will return the setting to its default value.

Experimental Features

Included with Hornbill are a number of experimental features. These are features that are currently being looked at as possible future functionality within Hornbill.

It is important to note that by definition, Experimental Features are provided as a way to allow our customer to preview some of the ideas we are experimenting with, these are "experimental’ and that means the following: -

  • An experimental feature may be either defective and/or feature incomplete.
  • An experimental feature is subject to change at any time, without prior notice.
  • An experimental feature may be withdrawn/taken out of service at any time, for any reason and without prior notice.
  • You should not make purchasing decisions on the basis of experimental features for the above reasons.
  • An experimental feature should not be relied upon on for production use. You are free to use experimental features in production if there is an option to enable it, but by doing so you are accepting the points herein.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document