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

Text Assist (AI Assist)

In Hornbill there are numerous places you might be writing textual content. AI Assist is a productivity feature powered by OpenAI that brings generative AI capabilities to your fingertips to help with improving on or expanding your written content, as well as providing you access to non-company-specific generalized knowledge. These features enhance your ability to write with great clarity, expand on common topics where required and access generic knowledge available to the underlying language model.

AI Assist is in the early stages of development as we consider, observe and better understand how customers make use of this as well as how we might further use Generative AI to enhance the user experience and productivity when using Hornbill.

Frequently Asked Questions

Can the AI Assist feature be disabled globally?

Yes, there is a global system setting which can be used to enable/disable this feature (just search in admin for integration.openai.enable to locate the setting)

Who is paying for the OpenAI service?

For now, Hornbill is picking up the bill for this, so for all customers, the usage of this feature is free of charge. It is possible for individual customers to provide an API key for their own OpenAI account should they want to track/manage usage via the OpenAI system, you can simply create an OpenAI API key and set it here (search admin for integration.openai.apiKey), once set, your instance will use this key for OpenAI related API calls.

Can AI Assist be restricted to defined groups of users?

No, its either on or off for all full users on your instance, this is not presented to any basic user or contact via the end user portals.

What is the backend system that is powering this AI Assist feature?

This is being powered by the OpenAI Service, this is the same generative AI system that powers ChatGPT

Do you have a Data Processing Agreement with OpenAI?

Yes a signed copy of the Data Processing Agreement between Hornbill and OpenAI is available upon request through customer success.

Where is the data being processed?

For Text Assist (previously AI Assist), the data is being processed on the OpenAI servers is the data the user types in, and/or selects when selecting the assist option, which is why we have provided the ability to disable this if thats not acceptable to your organization.

What assurances do we have arround data being stored?

You have the exact same assurances that we do, via the OpenAI Terms Of Use, specificly the section on Data Retention, Open AI stored user input and outputs are deleted after 30 days.

Has any consideration be given for what might happen if personal data is inputted and processed?

We do not feel there is a problem based on OpenAI current terms of use, but we recognize thad individual customers may well take a different view. This is why we provide the ability for individual customers to turn this feature off

Can we get any technical documentation and any other statements that Hornbill might have prepared to allay any of the numerous concerns of these types?

This is in the very early stages of development, today is very simple and does not warrant any significant documentation in its own right, its just a nicely done integration to an existing AI GenAI service. We are still deciding on exactly how this applies and will be used in the long term, we have limited internal technical documentation that would be customer-friendly, so at this time we do not. We would refer you to the OpenAI API documentation which will give you a lot more insight into how the GenAI system works.

Does the feature offer insight into any of our Business-Specific process models and offer our users insight into how we can better use the Hornbill product?

No not at this time, its purely there as an assistive tool to help with generalized writing, grammar and general/generic knowledge access

In This Document