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


BPM stage types.


Name Type Occurrence Description
checklist bpmStageChecklistType Optional The checklist defined for the bpm process. All the required item has to be checked to goto the next stage else the process failed.
completionThreshold xs:duration Optional PRELIMINARYThe amount of time you expect the stage to be completed in. This will only be measured if a Service Level Calendar (slcName) is defined. Completion is only calculated when a stage completes successfully.
description xs:string Optional The description for bpm stage.
displayName xs:string Optional The display name for bpm stage.
flow bpmFlowType Required The flow defined for the bpm process. It should have one start node and atleast one stop node. Flow can be suspended by the approval/task node.
id bpmIdType Required The unique id for stage.
slcName xs:string Optional PRELIMINARYThe name of the service level calendar used to measure working time taken to complete. If not specified then the workflow’s defined SLC will be assumed. If no workflow-level SLC is defined then working time will not be measured.
stageMetaData xs:string Optional Holds meta data used by the user interface.
translatedDescription bpmLabelType Optional
Array (0/∞)
any translated description for stage
translatedDisplayName bpmLabelType Optional
Array (0/∞)
Translated display name for stage
In This Document