Documentation

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

Dashboards

Dashboards are used to display widget content.

  • Dashboards can be customized to include multiple rows and columns to which widgets can be added.
  • Dashboards can be shared with specific users and roles
  • Dashboards can be displayed on large screens or consumed into slides and displayed in Slideshows.

Creating a Dashboard

Start by selecting the + Create New Dashboard button on the Dashboard landing page, and give the Dashboard a name.

In order to access the configuration options for the Dashboard select the Edit Mode button in the top right of the Dashboard canvas

Defining Dashboard layouts

Adding additional rows

  • In order to add an additional row below the default row, select the + button in the top left hand corner of the default row. This will add a new row directly below.
  • In order for the rows to correctly display on the Dashboard ensure that each row is set to 50% Height (next to the + and dustbin buttons on each row)
  • To add additional row’s, select the + button on the row to which you want the new row to appear below. If adding multiple rows, ensure that each row is allocated a % Height value and that the total of all the row height % equals 100.

Adding columns to rows

  • In order to add additional columns to a row, select the Screen Shot 2015-11-24 at 21.20.49.png button from the top right hand corner of the row. This will add a column to the row.
  • In order for the columns to correctly display on the Dashboard ensure each each column is set to 50% Width (next to the Chart button in each column).
  • To add additional columns to a row select the Screen Shot 2015-11-24 at 21.20.49.png button from the top right hand corner of the row. additional columns will appear on the row.
  • If adding multiple columns to a row, ensure that each column is allocated a % Width value and that the total % width of all columns on a single row equals 100.

Adding widgets to columns

  • In order to add a widget to a column on a row, there are two options which need to be configured.
    • Type of Widget
      This will be a drop down of all available Widget types (Chart, Scorecard, Target Counter, Itemized Count List, Custom), select the type of Widget you wish to add.
    • Widget
      Based on the type of widget chosen above, a list of defined widgets of that type will be displayed and can be chosen from (Only widgets marked as ‘Available for Use’ will appear in the list.
  • The chose widget will then appear in the column. If the wrong widget has been chosen, click on the ‘Dustbin’ button on the widget (not the Dustbin on the column header) to remove the widget and allow for another widget to be selected.

Adding multiple widgets to a single column

  • In order to add multiple widgets to a single column on a row, click on the Charts button on the column, this will add an additional widget to the row. Multiple widgets can be added to a single column.
  • Configure the content of each widget in the row, as directed in the Adding Widgets to Column section above.
    • Remove widgets from a column by selecting the Dustbin button in the top right hand corner of widgets you wish to remove.

Row and column heights and widths

  • Ensure that the total of all row heights equals 100% in order to correctly display on the Dashboard.
  • Ensure that the total of all columns widths per row equals 100% in order to correctly display on the Dashboard.

Moving Columns between rows

It is possible to move columns of widgets between rows by dragging and dropping the columns as required

  • Ensure when moving columns between rows, that the width of all the columns on each row equal 100% to display correctly.

Managing Dashboard Settings

Once the Dashboard layout, and widget content is configured it is important to complete the Dashboard Settings .

  • Title
    Name of the Dashboard
  • Description
    Dashboard purpose and or content
  • Status
    By Default this is set to In development, once the Dashboard is configured the status should be changed to Available for use. Only Dashboards marked as Available for use will appear when configuring the content of slides in slideshows.
  • Access Granted To
    Determine who to make the Dashboard available to. It is possible to assign the dashboard to multiple Users and Roles. Add Additional Users and Roles by using the Add New option. Switch the context between User and Role by clicking on the User / Role header and then selecting the user or role accordingly
  • Save
    Save the Dashboard by selecting the Save (disk) icon.
  • Copy
    Create a copy of the Dashboard layout by selecting the Save As option from the drop down next to the Save (disk) icon, and giving the new Dashboard a name.
In This Document