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

Service Levels

One or more Service Levels can be defined for each Service Level Agreement. Each Service Level contains configurable Service Level Targets and their associated automated escalations. Service Levels are required if you need to automate and track targets such as response and resolution targets.

  • Name
    The name of the Service Level will be displayed along with the SLA on a request that it is assocaited to. This is used to help a support person understand the Service Level that they need to adhear to. An example of a common naming convention for Service Levels is Bronze, Silver, and Gold.
  • Description
    Define the purpose of the SL and what it covers. This can be used by Service Desk Staff when changing an applied Service Level against a request.

Service Level Targets

Service Level Targets allow you to define the timing for your response and resolution targets. Providing these targets is optional, however using these is an important part of keeping track of the performance provided by the service desk. Both the response and resolution targets are calculated against the selected Working Hours Calendar. By selecting any of the existing Service Levels you will be able to manage the associated targets for that Service Level.

Target Types

  • Response Target
    The time in which a response to a new request needs to be made.
  • Resolution Target
    The time in which a suitable resolution to a request has been completed and a normal level of service provided.

Service Level Target Calculation

The service level targets that you add to Hornbill relate to the working hours defined in the working time calendar specified against the SLA. This means that some calculation is required to ensure the targets you set represent the correct number of calendar days that you are advertising to your customers.

Example

If you have a target that you advertise as 5 calendar days, you need to determine what this equates to in days, hours, and minutes in relation to the hours defined in your Working time calendar.

  1. Begin by multiplying your target (in calendar days) by the working hours set in your working time calendar (your working day) i.e. 5 x 9.5. Now divide the result of that by 24 (i.e. (47.5)/24) which gives your Hornbill target in days (i.e. = 1.98 days).
  2. You place “1” in the field representing “days”.
  3. It’s then a case of working out what .98 of a day is in hours – which in this case would be 24 x 0.98 = 23.52 hours.
  4. You place “23” in the field representing “hours”.
  5. Finally, we then need to get the minutes from our answer of 23.52. Therefore, 0.52 of an hour is 31.2 minutes (i.e. 60 x 0.52 = 31.2 minutes).
  6. You place “31” in the field representing “minutes”.

Therefore the target of 5 calendar days based on a 9.5 hour working day equates to 1 day, 23 hours, 31 minutes.

More details of this can be found in the Service Level Workflow Automation document.

Escalation Actions

Against each Service Level Target you can configure escalation actions which will get automatically invoked should the Service Level still be active at defined time intervals before and or after the specific Target of the Service Level.

Timers

Against each Service Level Target you can configure escalation actions which will get automatically invoked should the Service Level still be active at defined time intervals before and or after the specific Target of the Service Level.

  • Before the Target
    Specify this in Days / Hours / Minutes how long before the Target has been reached that an event will take place
  • After the Target
    Specify this in Days / Hours / Minutes how long after the Target has passed that an event will take place

Actions

You can specific one or more Actions which you want to be invoked against each Escalation Event. Configure the required Actions by clicking on the icons to expose the configuration options for each action type.

  • Send Notification
    This will send a Hornbill notification to the following (If this has been specified).
    • Owner
    • Owners Manager
    • Team (Which the request is assigned to)
    • Specified Recipients
  • Post to Timeline
    Tick if you want the notification text to be posted on the timeline of the impacted request.
  • Notification Text
    Specify the text which will appear in the Hornbill Notification
  • Send Reminder
    This will send an email to the following(if this has been specified).
    • Owner
    • Owners Manager
    • Team (Which the request is assigned to)
    • External Email Addresses (multiple - Comma separated) Mailbox**
      Name of Mailbox where the email will originate To - The Recipient Email Template - The Predefined Email Template which will be sent Subject - The Email Subject Escalation Text - The text which will appear inside the predefined email template specified above
  • Assign
    This option will reassign the request to a specified team, and or individual analyst.
  • Increase Priority by 1
    What ever the priority is currently at, this will increase the priority by one level.
  • Add to Board
    If you have boards configured, this option will add the request to a specified board, with the option to specify a particular list within the chosen board. If no list is specified, then the request will be added to the first (left-most) list on the Board. Typically this can be used to create a Breach Board, with lists representing the time left before the Service Level Target will be missed. More information on Boards can be found on the My boards wiki page.

Managing Service Level Rules

If you create more than one Service Level for any of your SLA’s, you will enable the Manage Rules tab. This will allow you to configure rules to manage when the different Service Levels of your SLA should be used. Learn more about configuring rules for your Service Level Agreement here

In This Document