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

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

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
name appNameType Required The name of the application.
storeId xs:string Optional The store ID that this application was installed from.
status appStatusType Optional The application’s current installation status.
build xs:unsignedInt Optional The application’s current installation status.
hotfix xs:unsignedInt Optional
Default=0		 The application’s current hotfix being applied.
versionTag xs:string Optional The application’s current version tag.
icon xs:string Optional The application’s icon class
newBuildAvailable xs:unsignedInt Optional If specified and the value is greater than ‘build’ then a new version of the application is available.
appTitle xs:string Optional The application title.
appVersion xs:string Optional The version of the application when released.
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.
price xs:decimal Optional The price of the application.
shortDescription xs:string Optional The short description of the application.
availability xs:string Optional The availability of the application.
platformEditionRequired platformEditionType Optional
Default=Standard		 Indicates that platform edition that is required for this application.
adminModules appAdminModulesType Optional Indicates the platform provided app admin modules that are required 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.
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.
featureOptionAnalytics xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Advanced Analytics platform feature is required for/used by this application.
featureOptionAutoTask xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Auto Task platform feature is required for/used by this application.
featureOptionLifecycle xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the Lifecycle 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.
featureOptionEmailTemplates xs:boolean Optional
Default=false		 DEPRECATED (see adminModules): Indicates that the application requires email template management.
featureOptionSimpleLists xs:boolean Optional
Default=true		 DEPRECATED (see adminModules): Indicates that the application requires simple list management.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document