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

Hornbill Administration

Hornbill's integrations with Hornbill Administration enable the management of users, group memberships and role associations across multiple Hornbill instances.
This is a Free Tier Integration.

Cloud Automations

Hornbill Administration

OperationDescription
Add User to Company Group Hornbill Integration method for associating a user to a group (company). The Hornbill account must be authenticated in KeySafe first.
Add User to Costcenter Group Hornbill Integration method for associating a user to a group (costcenter). The Hornbill account must be authenticated in KeySafe first.
Add User to Department Group Hornbill Integration method for associating a user to a group (department). The Hornbill account must be authenticated in KeySafe first.
Add User to Division Group Hornbill Integration method for associating a user to a group (division). The Hornbill account must be authenticated in KeySafe first.
Add User to General Group Hornbill Integration method for associating a user to a group (general). The Hornbill account must be authenticated in KeySafe first.
Add User to Team Group Hornbill Integration method for associating a user to a group (team). The Hornbill account must be authenticated in KeySafe first.
Associate User to Role - Collaboration Hornbill Integration method for associating a user to a role (collaboration). The Hornbill account must be authenticated in KeySafe first.
Associate User to Role - Document Manager Hornbill Integration method for associating a user to a role (Document Manager). The Hornbill account must be authenticated in KeySafe first.
Associate User to Role - Service Manager Hornbill Integration method for associating a user to a role (Service Manager). The Hornbill account must be authenticated in KeySafe first.
Create a New User Hornbill Integration method for creating a Hornbill user. The Hornbill account must be authenticated in KeySafe first.
Remove User from Company Group Hornbill Integration method for removing a user from a group (company). The Hornbill account must be authenticated in KeySafe first.
Remove User from Costcenter Group Hornbill Integration method for removing a user from a group (costcenter). The Hornbill account must be authenticated in KeySafe first.
Remove User from Department Group Hornbill Integration method for removing a user from a group (department). The Hornbill account must be authenticated in KeySafe first.
Remove User from Division Group Hornbill Integration method for removing a user from a group (division). The Hornbill account must be authenticated in KeySafe first.
Remove User from General Group Hornbill Integration method for removing a user from a group (general). The Hornbill account must be authenticated in KeySafe first.
Remove User from Team Group Hornbill Integration method for removing a user from a group (team). The Hornbill account must be authenticated in KeySafe first.
Update User Profile Hornbill Integration method for updating a Hornbill users profile. The Hornbill account must be authenticated in KeySafe first.

Simple List Management

OperationDescription
Add Item to List Hornbill Integration method for adding an item to a simple list. If the target simple list does not exist, it will be created and the item will be added to it.
Remove Item from List Hornbill Integration method for removing an item from a simple list.
In This Document