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

Change Calendar

The Change Calendar provides a view of the scheduled changes and release packages. This gives an indication of the availability of a change or the possible disruption of a change being implemented.

Calendar

The Calendar provides a month by month view of the scheduled changes and releases. Changes and releases will only be visible if a schedule date has been added manually to the request using the Schedule Action Item on the request, or automatically using the schedule change / release business process options.

Views

On the tool bar there are a number of views that have been provides that allow you to filter the calendar to only show particular changes or releases. These views include

  • Changes
    This option will only show Change Requests which have been scheduled on the Calendar.
  • Releases
    This option will only show Releases which have been scheduled on the Calendar
  • All
    This option will show both Change Requests and Releases which have been scheduled on the Calendar
  • All Requests
    This option will show all requests irrespective of ownership or which Service they have been raised against
  • My Requests
    This option will show all the Changes and Releases that are owned or assigned to the person viewing the calendar
  • My Services
    By selecting the My Services option, only the Changes or Releases that are associated to the services that the user supports are visible. This can be filtered down to an individual Service by selecting a service that is listed under this option.

The calendar can be filtered to show requests that come under a particular authorization status. These include:

  • Not Authorized
    View changes that where the authorization is still pending
  • Authorized
    View changes that have been authorized
  • Rejected
    View changes that have been rejected
  • All
    When All is selected, requests in the calendar can still be identified as Authorized by the green flag along the left side of the scheduled request, and Not Authorized with a blue flag along the left side of the scheduled change. In addition the type of request can be identified by it’s icon on the scheduled entry.

Status Colors

The status of changes and releases on the calendar can be easily seen by the following color scheme

Color Description
Blue The change is in an open state
Green The change has been successfully resolved
Gray The change record has been closed

Change Freeze Periods

Users with the Full Change Management Access or the Full Release Management Access roles will be able to add and manage global change freeze periods on the Change Calendar.

Adding a new Change Freeze period

Users with the above roles will be able to select the Change Calendar Freeze period icon to add, edit or remove change freeze periods.

To add a new change freeze period

  1. select the + icon
  2. Provide a start and end date and time
  3. Provide a change freeze description

Edit or Delete Change Freeze Periods

  1. Select the Change Calendar Freeze period icon and either the pencil to edit the date / times or description of the change freeze, or the trash can to permanently delete the change freeze period

All Active change freeze periods will be visible on the change calendar and are indicated by a gray color in the calendar dates.

  • Hovering over a change freeze period will display more information
  • Change Freeze periods are automatically checked on Change and Release requests when users attempt to schedule dates to the change calendar. Collisions are highlighted, and enforced.

Access

The following roles are required to view and use this feature

Role Description
Change Calendar Viewer This role will enable the Change Calendar menu item under Service Manager. View only access to the Request List for changes will also be available.
Collaboration Role This role is required for all users using the Hornbill portal.
In This Document