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

Using Configuration

Hornbill Configuration gives you access to all the configuration settings for Hornbill. Configure your organizational structure including departments, teams, and the users who will be using Hornbill. Set up email, languages, view your subscriptions, install apps, and much more. The different areas within Configuration are sensitive to your rights and each user will only see the options to which they have been granted access.

Topics Covered

  • How to access Configuration.
  • How to search.
  • Browsing Configuration.

Before You Begin

To access Configuration one of the following is required

  • Log in as the Admin User.
  • Log in as a user that has the Admin Role.
  • Log in as a user that has a role that contains a system right to Manage one or more of the areas within Configuration. These users will only see the areas in Configuration where they have been provided the system right.

Accessing Configuration

Access Configuration by selecting the cog icon displayed at the bottom of the left-hand icon bar. Alternatively, use [Ctrl + Shift + S] on your keyboard.

Searching Configuration

The search bar presents results as you type. Search results only include items based on the rights and roles of the user performing the search.

search

Using Search from the Keyboard

Access the Configuration Search from anywhere within Hornbill using the keyboard shortcut Ctrl+Shift+S. After you have entered search mode start typing and the most relevant search results will be returned as you type. Once you are presented with one or more search results. Use the Up/Down arrow keys to highlight the search result of interest and press to navigate to that item.

Example search:

  1. On your keyboard use the key combination Ctrl+Shift+s.
  2. In the search box type user.
  3. View the contents in the results list.
  4. Click on Manage Users.

Search Help

Click on the to show a list of additional search options. This includes prefixes that can be added to your search text in order to get more focused results.

Browse

The dropdown menu in Configuration allows you to select the different areas that can be configured. When first opening Configuration, the view will default to My Personal Settings where a user can update and modify their profile. Other available options include Platform Configuration, Hornbill Solution Center, and a list of the installed applications. The availability of these items is determined by the rights and roles of the current user.

Browsing Configuration

Tip

This list includes access to the configuration for each installed app. The visibility of the apps in this list is controlled by application roles. For more information, please refer to the relevant configuration guide for each app.

After an option is selected, the navigation panel can then be used to access individual configuration options and settings.

Navigating Configuration

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document