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

Entity Explorer

Each Hornbill application is delivered with access to its database schema and entity relationships. This is useful when trying to understand where to identify tables, table columns, primary keys, and suitable fields for making your table joins. This functionality is intended to make your quest for information that little bit easier when constructing those all important analytics and management reports.

Roles and Rights

Accessing the Entity Explorer in the Administration Tool is only open to users who are assigned the Advanced Reporting Admin role and a secondary role that has the Execute Stored Queries and Update Records system rights. Apart from high security roles, the latter can be a default role (which has these system rights) or custom created role.

Features

  • Entity Information
    Provides a visual interface to explore the application tables and how they relate to each other. A quick way to identify extended tables and the columns that create table links. Click on a table and use the “Description” and “Information” buttons to the top right of the graphical user interface to explore each table in more detail.

  • Database Schema Information
    A simple description of each application table. Understand more about the columns contained in the tables including a supporting description, type, and information on which columns are indexed.

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