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

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Sentiment Analysis Configuration

Important

HAi features are currently in a closed beta. You can only access these features after you register. Contact your Hornbill Customer Success representative to join the program.

Before you begin

Ensure you have enabled HAi features. You can customize how much data the system uses and which timeline update types trigger a request summary. To manage these settings, navigate to the application settings for Service Manager.

Setting Description
generativeAi.sentimentAnalysis.availablePostTypes Determines the types of posts used to generate the request sentiment. Valid values include: Authorization, Customer, Email, Escalate, and update.
generativeAi.sentimentAnalysisAutoUpdates Enables or disables automatic request sentiment analysis when a customer provides an update.

Auto updates

When you enable Auto Updates, the system checks the sentiment of a request if the person posting or commenting is the customer associated with that request. This applies to the following scenarios:

  • Customer Portal: The customer adds a timeline post or comment.
  • Employee Portal: The customer adds a timeline post or comment.
  • Email Auto Responder: The system updates a request via an email sent by the customer.
  • Mailbox: A user applies an email to a request where the sender is the customer.

Data processing

When the system performs a sentiment analysis, it processes specific data from the active request.

Request fields

The following technical fields are processed:

  • h_itsm_requests.h_description
  • h_itsm_requests.h_summary
  • h_itsm_requests.h_fk_user_name

Timeline data

The system filters the request timeline using the following criteria: ["Customer","Email","update"]. For every post in the filtered timeline, the system sends the following data:

  • actorInfo.name
  • content

For any comments associated with these filtered posts, the system sends:

  • actorInfo.name
  • comment

Custom questions

The system passes the first 100 custom questions. It excludes file-upload and label types. The data is paired using the following format:

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