Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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

Image Library

The Image Library is used to host images that can be used within different areas of Hornbill. For example, the Employee and Customer portals.

Before you begin

To access the Image Library, you must have one of the following roles.

  • Admin role.
  • A user created role that contains the system configuration right manageImageShare.

How images are used

A URL is provided with each image that can be used within a number of areas within Hornbill

  • Employee Portal
  • Customer Portal
  • Intelligent Capture
  • Email Templates

Privilege levels

With each image that is uploaded to the library, there is an option providing three privilege levels.

  • Public
    Images set with the privilege of Public can be viewed by anyone. No login to Hornbill is required. This can be used for images that are displayed on the Login Screen or on emails sent from Hornbill that need to contain images.
  • Guest
    This privilege level requires that the user is logged in with a minimum of a guest level. This can be used for images that you would like to display on the Customer or Employee portals, but do not wish to have publicly accessible. Intelligent capture scripts that are visible to authenticated guests can also contain images that are provided by the library.
  • User
    Use this level when access to an image needs to be restricted to only full users.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document