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 Availability

Analyze Service Availability in Hornbill. As the Status changes on a Service from one state to another, information is automatically collected to provide availability metrics.

Managing Service Status

The default position is ‘No Status’, this will result in no status or message being displayed, this is important when Service Status is not relevant to a Service.

The Three Status options are

  • Available - Indicated by a green icon
  • Impacted - indicated by an amber icon
  • Unavailable - indicated by a red icon

When any of the above status’s are chosen a default message will be displayed, and can be edited. Once saved the status and message will be visible to the subscribers of the service on the Service and or Customer Portals, and analysts who support the Service through the user app in the following places:

  • Services List
  • Request List
  • Request Details
  • Progressive Capture - Services Form

Supporting Messages can be seen by Hovering over the Service Status Icon.

  • To Change the Status of the Service, simple select a different option from the drop down list and save.
  • To remove any Status, simply select the ‘No Status’ option from the drop down list and save.

In the user app and the Request Details view, the Service Name will take you through to see more information about the service. The Level of information visible to you will depend on your rights to view the Service, including:

  • If the Service is Open or Private these rights will be respected
  • If you are the Owner, or a member of a team which supports the Service
  • If you do not have Services Manager right, you will still be able to see very basic Service Details but no edit rights.

Automatically Changing the Status of a Service

Through the business process designer it is possible to automate the changing of the status of a service using the Automated Task node and the Request > Request Service > Update Service Status option from within business processes.

Availability Metrics

  • Mean time between failures (MTBF)
    The average time between instances of service unavailability
  • Mean time to repair (MTTR)
    The average time to restore service availability
  • Percentage Availability
    The percentage of time the service is available

The availability metrics can be accessed using the chart icon next to the service status. At least one change in the status is required in order to view the metrics, and two status changes are needed to show the MTBF metric.

Data

To compliment the availability metrics a full list of all changes in the Services Status (Availability) are recorded and displayed under the Data option.

  • Status
    The status the Service was sat in (Available, Unavailable, Impacted)
  • From
    The date and time the Service was in this status
  • To
    The date and time the Service changed from this status
  • Duration
    The total time the service was in this status
  • Action
    Use this option to manually exclude a Status change from the overall Availability Metrics. If a status change was made in error, or testing you may wish to exclude this from the Services overall Availability Metrics.

Filter the Data list to show:

  • All Records
  • Included Records
  • Excluded Records

Date Range

By Default the Availability Metrics will be set to look at the previous 3 months.

  • Manually alter the date range to view the Availability Metrics for any given time period.
  • Use the refresh icon to return the date range to the default previous 3 month period

SLA

By default the Availability Metrics will be based on a 247 clock, however it is possible to display the Availability Metrics based on the working days / hours of the working time calendar which underpins any SLA which is available on the Service.

Change the SLA to view the Availability Metrics for the Service based on the working hours of the SLA.

Tip

Whilst it is possible to add custom service statuses via the servicestatus simple list, the availability metrics are only calculated on changes to the default statuses (Available, Unavailable and Impacted)

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