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

Low-Level Database Query Tool

The Low-Level Database Query Tool is an advanced debugging feature of the Hornbill Platform which allows you to query the underlying application database using Structured Query Language (SQL) statements. Every Hornbill instance incorporates this feature however it is not enabled by default and its use is not encouraged. This feature is intended for advanced users only to support diagnostics of issues and problems.

Warning

This function of the Hornbill platform is disabled and protected behind a super-user privilege level because it exposes some inherent security risks with regards to accessing data a user may not be authorized to access. As a result this feature is likely to be depreciated in the future. The platform, and our cloud operations and support capabilities have matured beyond the point where this is beneficial, there are no use-0cases where its really necessary to access the underlying database in this way.

Enabling the Low-Level Database Query Tool

The visibility of Low-Level Database Query Tool is governed by a system setting security.database.allowSqlQueryOperation. Any user wishing to use the Low-Level Database Query Tool must be assigned the “Super User Role”.

Once the application setting has been enabled, it may be necessary to refresh your browser to allow this change in this setting to be acknowledged. If the association of a role is also required, it will be necessary for the user to log out and then log in again to ensure the user’s session is aware of the recent association of the Super User role.

Using Low-Level Database Query Tool

Once enabled, Low-Level Database Query Tool can be found via Home > System > Data > Low-Level Database Query Tool. The key features are outlined below.

  • Query Editor
    Type your SQL query here
  • Data Format
    Choose whether raw data values are displayed (e.g. boolean flags will appear as 0 or 1) or if data formatters are to be applied (e.g. No or Yes). Not all data is subject to data formatting.
  • Clear
    Clears the current query in the query pane and result set.
  • Execute
    Execute the query that exists in the query pane
  • Execute Selected Text
    If more than one query exists in the query pane, highlighting the query and using this button will execute the highlighted query.
  • Table filter
    Filter the list of Hornbill tables by typing in text.
  • Table List
    Shows all the tables available based on the applications you have installed on your instance.
  • Manage Saved Queries
    If you have saved any queries, you can manage them here.
  • Show/Hide Query Editor
    Toggle whether the query editor is displayed or not. This may be useful when examining larger result sets.
  • Show/Hide Table List
    Toggle whether the table list is displayed or not. This may be useful when examining larger result sets.
  • Save Query
    Saves the current content of the Query Editor
  • Query Limit
    All queries executed in the Low-Level Database Query Tool are subject to a limit, adjust the number of records returned here.
  • Result Quick Filter
    Filter the results set currently displayed.
  • Column Display
    When examining your result set, choose to display friendly column display names or raw column database names.
  • Export
    Export your result set to a variety of formats including CSV.
  • Result Set
    The set of results returned by the last query you executed.