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

Defining Working Time

Working time defines the working or operational hours for your organization. Working time can be used by the different Hornbill apps to determine when users are scheduled to work.

Topics Covered

  1. Setting a default working time zone.
  2. Adding default exclusion days, such as holidays.
  3. Setting the default working days and hours.
  4. Creating Working Time Calendars for multiple time zones and work schedules.

Before You Begin

This guide takes you through administrative configurations. The following will be needed to complete this guide:

Tip

To access any of the settings described in this document, open Configuration and search by the setting name

Working Time Zone

Hornbill can be used across multiple geographical regions and time zones. Select the time zone that represents where the users are located. This will ensure that the correct times are stored for the activities that they perform.

Setting Name Description Example
system.defaultWorkingTime.timezone Sets the default time zone GMT Standard Time

Exclusion Days

Add individual days that will be excluded from the working time. This is commonly used for holidays but it can also be used for any other non-operational day. Both single-day events and reoccurring events can be set.

Setting Name Description Example
system.defaultWorkingTime.exclusions Sets the default working time exclusion days. Each exclusion should be specified in the format “d:m:y:[comment]”. For annually reoccurring exclusions, use * for the year. 1:1:*:New Year’s Day

Tip

To exclude a day, set the working hours to 00:00-00:00

Working Time Calendars

When an organization has users that work across different schedules or in different time zones, multiple Working Time Calendars can be created.

To access Working Time Calendars

  1. Open Configuration.
  2. Search for Working Time Calendars.

Working Time Calendar

Time Zone

Hornbill can be used across multiple geographical regions and time zones. Select the time zone that represents where the teams or users who will be using this particular Working Time Calendar are located. This will ensure that the correct times are stored for the activities that they perform.

Day and Hour Selection

Using the grid, mouse over the days and the hours while holding down the left mouse button to select or deselect the working times. Each block highlighted in blue represents an active time.

Holiday Exclusions

Add individual days that will be excluded from the Working Time. This is commonly used for holidays but it can also be used for any other non-operational days. Both single-day events, as well as reoccurring events, can be set.

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