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

Log Files

For all the activity that takes place on Hornbill, including interaction by the users and the processing done by the platform on your instance. This is the perfect place to go to when investigating either the success of an action taking place or for troubleshooting when things don’t go right.

There are a number of different log files that are available for different aspects or areas of Hornbill.

  • api.log
    View this log to see the different APIs that are being used and see how fast they are responding.
  • EspCrawler.log
  • EspDbTool.log
  • EspEventService.log
  • EspFileService.log
  • EspIndexerService.log
    View this log to see events and activities with the Indexes that are on your instance.
  • EspInsightService.log
  • EspMailImporter.log
    View this log to monitor events related to connecting to your email server and the importing of emails from this service into Hornbill
  • EspMailService.log
    View this log to monitor events related to your mailboxes and the processing of incoming and outgoing emails
  • EspServerService.log
    View this log to monitor the main activity and events performed by users in the Hornbill Client

View Log Files

Clicking on any of the available log files will give you access to all the transactions being recorded for that particular log file.

Filters

The log files can be filled with important information that includes both successful transactions as well as errors.

Severity

A number of Severity Levels are provided to allow you to filter down on the type of transactions that are important to you.

  • Emergency
  • Alert
  • Critical
  • Error
  • Warning
  • Notice
  • Information
  • Debug
  • Settings

Archiving

There are a number of settings that will archive the log files when the associated Service is restarted on the instance. These settings are accessible in Configuration under Advanced System Settings.

Setting Description
logging.EspEventService.archiveOnStart Set this to ‘true’ if you want the EspEventService log file to be archived when the service is started.
logging.EspFileService.archiveOnStart Set this to ‘true’ if you want the EspFileService log file to be archived when the service is started.
logging.EspIndexerService.archiveOnStart Set this to ‘true’ if you want the EspIndexerService log file to be archived when the service is started.
logging.EspInsightService.archiveOnStart Set this to ‘true’ if you want the EspInsightService log file to be archived when the service is started.
logging.EspMailService.archiveOnStart Set this to ‘true’ if you want the EspMailService log file to be archived when the service is started.
logging.EspServerService.archiveOnStart Set this to ‘true’ if you want the EspServerService log file to be archived when the service is started.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document