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

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

{{book.title}}
More...

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