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

User Availability Status

These states are available to a user who can select a suitable state from their User Profile menu to make other users aware of their availability.

Tool Bar

  • Language
    From the language selector, you can chose a language that you would like to view or provide translations for. Translations are displayed in the UI Display column.
  • Add
    Use this button to add a new state to the list
  • Settings
    Control the visibly of this feature
    • Enable - Without Time Recording
      Only display the state
    • Enable - With Time Recording
      Include the time that the state was selected
    • Disable Feature
      Turn off the ability for users to select their availability state

Availability State List

  • Status
    The name of each of the available states
  • UI Display
    Shows the translation for the currently selected language. To update the translation, simply click on the text and provide a new translation to match the language selected in the toolbar.
  • In Use
    Enable or disable any of the available states. Default States cannot be deleted, but they can be disabled if they are not required
  • Present At Work
    if set, the user is present at work in your normal working environment, as opposed to being, for example, out in their car traveling to a client site.
  • Is Working Time
    This status indicates the user is in normal working time or not. They can be present at work, but out of working time, for example, They are staying late for some non-work-related reason.
  • On Call
    The user is on call, meaning they are available for on-call duties, they may or may not be present in their normal working environment, and they may or not be in their normal working time
  • Do Not Disturb
    The user might be at work, in working time, on-call or any combination thereof, but they are not to be disturbed. Having this selected will display the availability status in red

Tip

Reporting - The above information regarding the changes in state and the types of states can be found in the h_sys_accounts_status_log table

In This Document