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

Schedule

The Schedule Action Item lets you define a start and end date for when this request will be implemented. This feature is only available for Change Requests and Releases.

Adding and Removing a Schedule

The Schedule Action can be used for both adding a schedule and removing a schedule. A From and a To date fields are provided

Schedule Change

Both a From and a To date are required when scheduling a change or release. Once the dates are entered you can click on the Schedule Change button to add the schedule and have it display on the Calendar.

Change Freeze Periods

When attempting to schedule a change, if change freezes exist and collide with the date period for your change, the user will automatically be notified.

  • The Change Freeze icon will remain clear if no collision is detected, but will turn red Change collision detection red.png if the dates are during a change freeze. Users can click on the freeze icon at any time to manually view any clashes or upcoming change freeze periods.
  • If a user attempts to schedule and save during a change freeze period they will receive a message informing them that this this can’t be completed and to choose alternative dates.

    The exception to this rule is for any user who has either the Full Change Management Access or the Full Release Management Access roles, and they will be prompted and warned about the collision with any change freeze periods, but will have the rights to proceed with the changes scheduled dates. Change Freeze periods can be added and managed via the forward schedule of change calendar view by users whom have the above roles.

  • Schedule Action Icon Once a request has been scheduled, the icon for the Schedule Action on a request will turn Green to provide an indicator when viewing the request that a schedule has been set.

Workflow Automation

The adding and removing of a Change Schedule can be automated within the Workflow.

Add to Change Calendar

The From and To dates are set by selecting the number of days from the point that this step in the process is reached. For example Start this change 5 days from now and finish in 6 days from now. The corresponding dates will be automatically added.

Remove from Change Calendar

This will remove both the From and To dates from a change request. This can be useful for when a change or release has been rejected after it has been scheduled or you may want to remove the change from the Change Calendar once the change / release has been completed.

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