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

  • Article
  • 2 minutes to read

Description

This type represents information about the application installed on a Hornbill ESP Server.

Properties

Name Type Occurrence Description
adminModules appAdminModulesType Optional Indicates the platform provided app admin modules that are reuqired by this application.
appAuthor xs:string Optional The original author of this application.
appCopyright xs:string Optional The author’s copyright message.
appInformationUrl xs:anyURI Optional A URL to information about this application.
appTitle xs:string Optional The application title.
appVersion xs:string Optional The version of the application when released.
availability xs:string Optional The availability of the application.
build xs:unsignedInt Optional The application’s current installation status.
featureOptionAnalytics xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Advanced Analytics platform feature is required for/used by this application.
featureOptionAppUserSubscription xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the application requires user subscription management.
featureOptionAutoTask xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Auto Task platform feature is required for/used by this application.
featureOptionBpm xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the BPM platform feature is required for/used by this application.
featureOptionEmailTemplates xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the application requires email template management.
featureOptionLifecycle xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Lifecycle platform feature is required for/used by this application.
featureOptionProCap xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Prgressive Capture platform feature is required for/used by this application.
featureOptionReporting xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Reporting platform feature is required for/used by this application.
featureOptionSimpleLists xs:boolean Optional
Default=true		 DEPRECATED (see adminModules): Indicates that the application requires simple list management.
hotfix xs:unsignedInt Optional
Default=0		 The application’s current hotfix being applied.
icon xs:string Optional The application’s icon class
name appNameType Required The name of the application.
newBuildAvailable xs:unsignedInt Optional If specified and the value is greater than ‘build’ then a new version of the application is available.
platformEditionRequired platformEditionType Optional
Default=Standard		 Indicates that platform edition that is required for this application.
price xs:decimal Optional The price of the application.
shortDescription xs:string Optional The short description of the application.
status appStatusType Optional The application’s current installation status.
storeId xs:string Optional The store ID that this application was installed from.
updateNotificationRecipient xs:string Optional The email recipient(s) for automatic application update notifications.
versionTag xs:string Optional The application’s current version tag.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document