Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Complex Types - captureCustomQuestionType


This node is used to define single question.


Name Type Occurrence Description
binding xs:string Optional HB-FORM alternative binding to identify field when want to overwrite stored value during pcf flow
fieldMetaData xs:string Optional to store ui meta data as json
id simpleIdType Required HB-FORM field id.
isMandatory xs:boolean Optional HB-FORM isMandatory property, indicate if field is mandatory or not
isReadOnly xs:boolean Optional HB-FORM isReadOnly property, value can’t be edited
isSummary xs:boolean Optional If set to true then question and answer will be visible on right side in not active fragment.
isVisible xs:boolean Optional HB-FORM isVisible property
label bpmLabelType Required
Array (1/∞)
HB-FORM default label
placeholderText bpmLabelType Optional
Array (0/∞)
Text used as a UI placeholder when, for example a field is empty, this provides hint text
propertyStateConditions captureCustomQuestionPropertyCondition Optional
Array (0/∞)
field conditions that determine override properties like visibility, required readonly etc
showIfEmpty xs:boolean Optional HB-FORM still show in summary if value is empty
type xs:choice Required You need to specify one of the following choices:
In This Document