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

Installing An App

Hornbill includes an App Store where apps can be installed, updated, and removed. Applications are categorized under Installed, Premium, and Free. By clicking on each available application you are able to view the details of that application.

Topics Covered

  • How to install an app.
  • Providing access to an app using roles.
  • Basic app management.

Before You Begin

  • Admin user access is required.
  • General knowledge of using Configuration.

Installing Apps In The App Store

The Hornbill App Store is a place where one can go to browse, install, and remove applications on Hornbill. Applications are categorized under Installed, Premium, and Free. By clicking on each available application you are able to view the details of that application.

  1. Open Configuration and search for Hornbill App Store.
  2. Select one of the apps from the group of free apps.
  3. Click on the Install button to start the installation.

Hornbill App Store

Note

Premium apps can be installed at any time, however, subscription licenses must be applied before any users can be given access to the app.

Learn About Updates

Our platform and applications are continuously and automatically updated to ensure that all of our customers always have the latest features and fixes. This is done automatically without any service downtime and we guarantee that all customizations and integrations will continue to work.

When a new update of an installed application is available, a notification will be displayed in the Hornbill App Store. Applications are automatically updated during the maintenance window (0530 UTC Mon-Fri). If you wish to apply the update before the maintenance window, you can proceed with applying the update immediately by clicking on the Update button.

  1. Open Configuration and search using the name of the application. For example Hornbill Board Manager.
  2. In the results list under the section Hornbill App Store, select the application
  3. Click on the Update button.

Tip

The update button will only show if there is an available update to apply. If the update button is visible, you can expect the update to be automatically applied that same day during the maintenance window, without having to click on the Update button.

How To Manage Subscriptions

The Hornbill Solution Center provides information about your subscriptions for the different apps. Here you can add and remove users from a selected app while keeping track of how many available subscriptions you have.

  1. From the Configuration navigator, select Hornbill Solution Center.
  2. Under Subscription select Your Usage.
  3. Select Application Subscriptions.
  4. Under the subscriptions column, click on the subscription counter to view and modify the list of subscribed users.

Tip

Users can also be allocated subscriptions through role assignments. If you assign a user to an application role that has a privilege level of user a subscription will be allocated to that user when they next log in.

Uninstalling An App

If you happen to have an application installed that you no longer need, it can be removed with a click of a button. Have you uninstalled it by mistake? Not a worry…your data is intact. Re-install and start from where you left off.

  1. Search Configuration for the application name.
  2. In the results list under the section Hornbill App Store, select the application.
  3. Click on the Uninstall button.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document