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

Configuration Items List

The Configuration Item list shows all Configurations which can be managed and can be marked as being In Policy. Configuration Items which can be marked as In Policy are:

  • Assets
  • Services

Features

The Configuration Item list allows you to manage Configuration Items which can be marked as In Policy.

List Actions

Mark as In Policy

Next to each Configuration Item will be a green Tick or red Cross to indicate if the Configuration Item is currently In Policy or not.

  • Click on this icon to change it from being in Policy or not.
  • Configuration Items marked as In Policy may unlock additional functionality on the Configuration Item, and this is covered in Configuration Items accessible from the Related Articles section

Launch Explorer

Click on the CI Launch explorer.png icon next to a Configuration Item to launch the Explorer view.

  • The explorer view will allow you to view and explore related Configuration Items
  • The Explorer view will use the chosen Configuration Item as it’s root node

Filters

Search and filter the displayed Configuration Items using the following options

Quick Search

Search for a Configuration Item using the Quick Filter search box

  • Assets can be searched for based on Name, Asset Class or Asset Type
  • Services can be searched for based on Name, Description or Catalog Status

Policy Status

Filter the displayed Configuration Items by:

  • All
  • In Policy
  • Not in Policy

Configuration Type

Filter the displayed Configuration Items by either:

  • Assets
  • Services

Additional Type Specific Filters

Depending on the chosen Configuration Type the list will display different column attributes:

  • Assets - Name, Type, Class
  • Services - Name, Description

Within Assets type selected, two additional filters will be displayed in the action bar

  • Class - Filter the list of Configuration Items based on Asset Class
  • Type - Filter the list of Configuration Items based on Asset Type

Sorting

Sort the order in which the Configuration Items are displayed by using the Arrow icons on the list columns

In This Document