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


/ automation / runbookGetState


Invoke this operation get information about the specified runbook instance.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The runbookGetState method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
runbookId xs:string Required The unique identifier of the spawned runbook process.
returnRuntimeContext xs:boolean Optional
Set this to true if you would like to return the runtime context
waitSequence xs:unsignedInt Optional
Provide the last value returned in the waitSequence response parameter to wait for a status change
waitTime xs:unsignedInt Optional
The amount of time to wait (in seconds) for a staus change. Default is 10

Response Parameters

Name Type Attributes Description
name xs:string Required The name of the runbooks process
reference xs:anyURI Optional An application defined reference, such as a URN to an entity record or any other application-definable meaningful (to the application initiating the runbook) reference.
processState bpmStateType Required The state of the runbook process.
currentNode xs:string Optional The node identifier of the currently executed node in the runbook.
failureMessage xs:string Optional The error message in the case of process failure.
inputParam inputParameterType Optional
Array (0/∞)
The input parameters for the runbook.
outputParam outputParameterType Optional
Array (0/∞)
The output parameters from this runbook.
runtimeContext xs:string Optional Returns a JSON formatted object that represents the BPM runtime variables.
lastUpdated xs:dateTime Required Returns the date/time the process was last updated
waitSequence xs:unsignedInt Required You can use this value to call this operation again to wait for status changes
waitTimeout xs:boolean Required The wait timeout
In This Document