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


This operation creates a new task.


Name Type Occurrence Description
category xs:string Optional The category of task. This accepts expression inside &[…], which is evaluated to string.
customFields captureCustomQuestionType Optional
Array (0/∞)
Custom task field types to render for user to enter extended task data. This param is ignored for BPM Approvals.
details xs:string Optional A more detailed description with additional information that may be needed to assist with the completion of the tasks. This accepts expression inside &[…], which is evaluated to string.
dueDate xs:string Optional The date/time that the is expected to be completed by. If not specified then there is no due date defined. This accepts expression inside &[…], which is evaluated to dateTime.
extra xs:string Optional for holding extra info, currently used by core to store task checklist.
objectRefUrn xs:anyURI Optional Reference to an object specified by its URN
options taskOptionsType Optional Set one or more options for this task.
owner xs:string Optional The user account that is the owner of this task. If not specified then the user who created the task becomes the owner. This accepts expression inside &[…], which is evaluated to string.
priority taskPriorityType Optional
Identifies the priority of the task. If not specified, a default value of ‘normal’ is used. This accepts expression inside &[…], which is evaluated to string.
progress percentageValueType Optional In the case where a task will take some time to complete, this can be used to indicate the progress of the work being done. A value between 0-100 is valid. This accepts expression inside &[…], which is evaluated to Integer.
reference xs:string Optional Reserved for SYSTEM use and it’s ReadOnly
remindAssignee xs:boolean Optional
Should assignee be sent reminder notifications about task’s due for completion date.
reminder xs:duration Optional Duration before task’s due for completion date, when reminder notifications should be sent out. If not specified, default value will be picked from system settings “task.notification.taskDueReminder”.
remindOwner xs:boolean Optional
Should owner be sent reminder notifications about task’s due for completion date.
startDate xs:string Optional The date/time that work is expected to commence. If not specified then not startDate will be set. This accepts expression inside &[…], which is evaluated to dateTime.
timeSpent xs:unsignedInt Optional The default amount of time (in minutes) to set for timeSpent when creating task.
title xs:string Required The short description of the task to be actioned. This accepts expression inside &[…], which is evaluated to string.
In This Document