Documentation

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

/ admin / appOptionGet

Description

Invoke this method to get one or more application options and their associated values.

API Details

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

Request Parameters

The appOptionGet 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
appName appNameType Required The application you want to set the option for.
set xs:anyURI Optional If referencing a set of options, then this should be the set identifier
filter xs:string Optional If you want to list just a sub-set of the options provide the filter string. This is matched to the left of option Id, all options that match are returned.
searchMode xs:boolean Optional
Default=false
If set to ‘true’ then the ‘filter’ can use DOS-style wildcard searches. For example, ‘filter’ would return all settings that have the word ‘filter’ in the setting id.
returnNonDefaultValuesOnly xs:boolean Optional
Default=false
If you want to list just values that have been set to a non-default value set this to ‘true’. If set to false or not specified, then all config values scoped for the specified application are returned.
wantReadOnlyValues xs:boolean Optional
Default=false
It is possible for the application to include a (potentially) large number of read-only values that can not be edited by the administrator. If you want to include these values in the result set, then set this parameter to ‘true’.
wantAdvancedOptions xs:boolean Optional
Default=false
Advanced options are generally not for users to be set, so will not be visible in the admin tool by default. Set this to true of you want to also return advanced settings.
pageInfo pageInfoType Optional Controls the paging. If element is not specified, paging is disabled

Response Parameters

Name Type Attributes Description
option configOptionListType Optional
Array (0/∞)
The option value.
maxPages numberType Optional A number indicating the maximum number of pages that could be returned.
In This Document