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

Service Overview

The goal of a service is to deliver value to customers and employees through a variety of mechanisms.

Planning

The starting point to building a service catalog is to identify the services that are being offered. This could vary from a single service that offers IT help to users through self-serve, chat, and request management for a service catalog offering many services across different areas of the business.

Support Teams

The Supporting Teams feature is used to assign the Service Desk teams who will be supporting this service. Supporting teams will have the right to view and manage requests for this service. When a service is first created, it is supported by all Service Desk teams. Once one or more teams have been allocated to a service, only those teams will have access to the service.

Members of Supporting Teams can:

  • View All requests raised against the Service from the Request list > Filters > All My Services.
  • Be Assigned a request raised against the Service from Progressive Capture assignment forms, Request forms, and multi-select assignment options on the Request List view.
  • Only analysts who belong to those teams will be able to view and manage requests made against the Service.
  • It will only be possible to assign or reassign a request to another team or analyst in a team that supports the Service
  • Using the global search bar, analysts will only see results for requests that are logged against services their teams support, or requests that are assigned to them, their teams or where they have been added as members to the requests.

Optionally you can also filter the list of Services that are displayed on the Progressive Capture > Services Form, to only display those that belong to the customer they are logging the request for, but also just to those services which the Analyst supports (based on being a member of a team that Supports one or more Services). This could be useful if you only want the IT team to see the Services they Support, and equally the HR team to only see the Services they support when raising requests via Progressive Capture.

To enable this feature the following system setting needs to be turned on (is defaulted to Off). The Setting is accessible from the admin tool under Home > Service Manager > Application Settings servicemanager.progressiveCapture.servicedetails.enableSupportVisibility

Subscribers

Subscribers refer to those that consume the service. It is possible to subscribe customers to a service based on various organization groups. The default position for a service is that all customers will be entitled to use the Service.

Subscription Option Types

  • Company - Use this option to subscribe all internal customers to the Service
  • Department - Use this option to subscribe defined Departments to the Service
  • Team - Use this option to subscribe defined Teams to the Service
  • General - Use this option to subscribe a defined organizational group to the Service
  • User - Use this option to subscribe individual internal users to the Service
  • Site - Use this option to subscribe all users of a given site to the Service
  • Contact Organization - Use this option to subscribe specific external organizations to the Service
  • Individual Contacts - Use this option to subscribe individual contacts to the service
  • All Contacts - Use this option to subscribe all defined contacts to all supported external organizations to the Service

Tip

Department, Team and General options will only appear in the drop list once they have been defined under the Platform Configuration.

Subscribing Sub-Groups

By default each organizational grouping needs to be added individually to a service, for it’s members to be subscribed to the service. In the case where you have an organizational structure where you are utilizing sub-groups linked to a parent group - i.e Departments under a Company grouping, and the members of each department are listed under the relevant department but not also in the Company Grouping, you may want to subscribe all the departments and therefore all the members by simply subscribing the parent company grouping. To facilitate this approach you can do the following:

  • Enable the com.hornbill.servicemanager.services.subscriptions.allowSubgroupsInclusion system setting This will enable the ability to subscribe sub-groups to a service based on the parent grouping being subscribed - but it will not automatically:

    • Apply to existing Group Subscriptions
    • Apply to new Group Subscriptions

    With the setting enabled, you can now choose to allow sub-group subscriptions when applying new group subscriptions, and managing existing group subscriptions to a service.

Enabling Sub-Group Subscriptions

When subscribing a new organizational grouping to a service, or managing an existing organizational group subscription to a service, a Sub-Grouping Icon will now be visible.

  • By Default this will be set to Disabled
  • To Subscribe all members of the sub-groups to the service, based on their parent groups subscription, click on the icon to Enable.
  • To disable subgroup and their member’s subscription to the service, based on the parent grouping subscription simply click on the Icon to disable it.
  • The sub-group option will not apply to non-organizational based groupings i.e sites, users, and contacts.

Catalog Item Visibility in the Request Catalog for Sub-Group members subscribed via their Parent Organizational Grouping, will respect the parent’s inclusion or exclusion of each catalog item’s visibility.

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