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

Complex Types - configOptionListType

  • Article
  • 2 minutes to read

Description

This type represents an application or system configuration option returned in a list of options.

Properties

Name Type Occurrence Description
advanced xs:boolean Optional Defines the option as being an advanced option (not generally editable by users)
choice xs:string Optional
Array (0/∞)		 An array of possible values. If this is defined, then only one of these values are valid for the parameter.
choiceFlowcode xs:string Optional The name of a flowcode used to get the list of possible choices for this option’s value. appcode:flowcodename
choiceQuery xs:string Optional The name of a stored query to use to get the list of possible choices for this option’s value.
contentType xs:string Optional Defines the type of content stored in this option.
dataType configOptionDataType Optional Defines the data type this option supports.
defaultValue xs:string Optional The default value.
description xs:string Optional The text description for this option.
editable configOptionEditableType Optional Defines the editable status of this option
isDefault xs:boolean Required If set to true, then the value returned is the default value defined by the application out of the box.
key xs:string Required The key name.
maxInclusive xs:unsignedInt Optional If the parameter is a ‘number’ this can specify the maximum allowable value.
minInclusive xs:unsignedInt Optional If the parameter is a ‘number’ this can specify the minimum allowable value.
multiChoice xs:string Optional
Array (0/∞)		 An array of possible values. If this is defined, then any combination of these values are valid for the parameter.
pattern xs:string Optional A RegEx pattern that this value must match in order to be valid.
patternErrorMessage xs:string Optional A message to display to the user when the provided value does not match the specified patteren.
secure xs:boolean Optional Defines the option as holding informaiton that should be treated as secure.
value xs:string Optional The value.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document