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 Domains

Service Domains are used to define business areas where related services will be made available to users who will consume the services. Different Hornbill Apps have the ability to define their own Service Portfolio and the services that can be offered. Each of these services can then be allocated to a Service Domain. Examples of Service Domains may include IT, HR, and Facilities.

Role

Users will need the Service Domain Administrator role, in order to manager Service Domains

Details

Name/Description

  • Service Domain ID
    This is a unique identifier for the Service Domain. When adding a new Service Domain, this cannot be the same value as any other existing Service Name
  • Language
    This is to provide translations into different languages. This will provide translations to a user, based on the language specified in their user profile. The Default language is used in the situation where a user has a language set in their profile, but translations for that language have not been provided.
  • Name
    This is the Name of the Service Domain which will be displayed to the users within the Header of the home page.
  • Description
    The Description field can be used to make a note about the use or purpose of the Domain. At the moment this is not displayed to the customer on any of the pages.

Settings

  • Catalog
    This setting allows you to link the Service Domain to an existing Catalog.
  • Icon
    This associates an icon to this particular Domain. This icon maybe be visible within some of the different company pages
  • Enabled
    Once enabled, this Service Domain will be available on the company page. However, it will not become visible until there is a Domain Page created for it.
  • Public
    If marked as public, the domain page linked to the domain, will be visible to all employee irrespective if they are subscribed to services linked to the domain. If not marked as public, the linked domain page will only be visible to employees who are subscribed to services which are linked to the domain
  • System Domain
    This a read only setting that distinguishes between Service Domains that are provided by Hornbill and those that are manually created by you. System Domains cannot be deleted.

Domain Categories

A domain category allows you to associate one or more services to the category. This will allow for improved organization and navigation of Services when there are a large number of services available under a Service Domain. Each Category has the following options

  • Language
    This is only displayed after the category has been created. When a category is first created it populates the Default Language with the Name and Description. After the category has been saved, you can edit the category to create the language variations that are needed.
  • Name
    The name displayed to the users on the company pages
  • Description
    Hint text that is displayed to users on the company pages

Domain Owners

Domain Owners are given the rights to create and manage the pages that are displayed under this domain.

  • Add Owners
    Type the name of the user that you with to make the owner. More than one owner can be assigned to a service domain. Admin users also need to be added if they wish to manage pages for this domain.
  • Remove Owners
    Remove owners who are no longer needed access to manage the domain page.

Tip

Any service that exist in an application such as Hornbill Service Manager can be associated to a service domain using the appropriate fields that appear in the service details when creating or managing a service via the Service Portfolio. It’s also possible to set a “Service Domain Category” too.

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