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

Slideshows

Slideshows provide a way of automatically presenting a number of Dashboards one after another, and against definable transitions periods. These dashboards are great for large screen displays within your support center or they can be accessed by individuals via a Web Browser. The Slideshows are located within the Advanced Analytics under each application in the Administration Portal

Creating a new Slideshow

A new Slideshow can be created by clicking on the ‘Create New Slideshow’ button and giving the Slideshow a name.

  • Show
    Select a Dashboard to display on the Slide from the drop down list (only the Dashboards marked as ‘Available for Use’ will be displayed).
  • For
    The duration for which the Slide will be displayed before transitioning into the next.

Editing a Slideshow

It is possible to edit existing Slideshows to add additional slides, remove slides, change the order in which the slides are displayed, change the Dashboard which appears on each slide and change the period for which each slide will be displayed.

  • Adding additional slides
    Simply click on the + button and add a Dashboard, and the duration for which the Dashboard will be displayed
  • Removing an existing slide
    Simply click on the ‘Dustbin’ Icon on a slide to remove it from the Slideshow
  • Reorder slides
    Drag and Drop Slides to reorder the sequence in which they will display
  • Change the Dashboard being displayed on each slide
    Simply select a different Dashboard from the dropdown list (only Dashboards marked as ‘Available for Use’ will be displayed)
  • Change the duration each slide will display before transitioning onto the next slide
    Simply select a different time period for which the slide will be displayed
  • Creating a Clone
    Select the dropdown control next to the Save (Disk) icon and choose the ‘Save As’ option. Give the Slideshow a new name, this will create a complete copy of the existing Slideshow.

Running a Slideshow

When a Slideshow is ready to be presented there are two display options to choose from.

  • Run Show
    Click on the Play button, and the Slides will run in the order they have been configured.
  • Run Randomized
    Select this option from the drop down control next to the Play button, and the slide will ignore the configured sequence and will display in a random order.

Autoplay a Slideshow

You can create a slideshow and have it set to Autoplay.

The URL you can use is as follows:

https://live.hornbill.com//admin/app/com.hornbill.servicemanager/advanced-analytics/slideshows//play

  • Replace with your instance name
  • Replace with the id of the slideshow you want to autoplay - you can see the ID of the slideshow in the URL bar of your browser once you are viewing a slideshow in the admin tool

Tip

If you are intending to share the autoplay URL with other Hornbill Users please ensure the following:

  • The User has the Dashboard Viewer role
  • If you have applied Access Controls on the dashboards in the slideshow, that the user you want to view them via the slideshow has had the dashboards shared with them, their group or role

Deleting a Slideshow

One or more Slideshows can be deleted by selecting (ticking) the slideshows you wish to delete, and then selecting the ‘Delete Selected Slideshow’ option which is available from the dropdown control next to the ‘Create New Slideshow’ button.

In This Document