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

Configure HAi

Important

HAi is currently in a closed beta, speak to customer success should you want to take part.

Enabling HAi features

All HAi features are disabled by default and must be individually enabled before they can be used by end users. To enable any of the HAi capabilities, your User Account must be associated with one of the following roles:

Role Description
Service Desk Admin This role is for a Service Desk Administrator. This includes, an elevated visibility to Requests and associated actions, the ability to configure Service Manager features via the Administration Tool and the option to restart a failed BPM within a Request.

Additionally, any user with the application right rightA.administerServiceDesk can enable HAi features.

How to enable HAi features

  • Log into Hornbill with the relevant access role.
  • Click on the settings gear icon in the lower left of the screen.
  • Change the dropdown from ‘’‘My Personal Settings’‘’ to ‘’‘Service Manager’‘’.
  • Click on HAi under Administration in the left-hand menu.
  • Enable the required feature(s).

Hornbill Ai Configuration

Grant Users Access to HAi features

To access the HAi capability of Hornbill Service Manager, your User Account must have one of the following roles associated.

Role Description
HAi User This role allows users to access HAi functionality inside of Service Manager

Data

OpenAI Processor

By enabling any of these optional HAi features, you are agreeing to allow a third party to process your data (OpenAI), Data from prompts and underlying request data is passed to OpenAI under their business terms of use and their enterprise privacy policy. This prevents usage data from being used for training new models, the input and output of prompts is currently stored by OpenAI as outlined in their Documentation, all data is sent using encrypted connection.

The following areas of functionality send request data during each invocation and are document as follows:

Request Summariser

When summarizing a request the following data from the request you are in is processed:


    h_itsm_requests.h_description
    h_itsm_requests.h_summary
    h_itsm_requests.h_fk_user_name

The timeline of the request is filtered down with the following filters ‘[“Update”,“Email”,‘Customer’]’

Each post in the timelines sends the follownig


    actorInfo.name
    content

Each comment associated to any filtered posts in the timelines sends the follownig


    actorInfo.name
    comment

Custom Questions (first 100) are passed, excluding the type file-upload and label and are paired with the question text as follows:


    h_question
    h_answer_value

Suggest Resolution

When suggesting a resolution against a request the following data from the request you are in is processed:


    h_itsm_requests.h_description
    h_itsm_requests.h_summary
    h_itsm_requests.h_fk_user_name

The timeline of the request is filtered down with the following filters ‘[“Update”,“Email”,‘Customer’]’

Each post in the timelines sends the following


    actorInfo.name
    content

Each comment associated to any filtered posts in the timelines sends the following


    actorInfo.name
    comment

Knowledge Draft

When generating a knowedge draft from a resolved or closed request the following data is sent:


    h_itsm_requests.h_description
    h_itsm_requests.h_summary
    h_itsm_requests.h_resolution

Text Assist

Text assist combined with snippets or used withing a workflow and passing in variables can pass any data a user has selected to pass to OpenAI, nothing is sent automatically. In the case of snippets, when the snippet is selected the analayst will see the data before the text is passed as part of the prompt when using Text Assist after a snippet.

OpenAI Usage

Usage of the OpenAI API’s goes through an API Key provided by hornbill. Currently there are no usage limits outside the limits provided by OpenAI. It is possible to override the API to use an API Key of your organization’s choice by overriding the system setting integration.openai.apiKey.

Further details on this here: https://docs.hornbill.com/esp-fundamentals/productivity/ai-assist

In This Document