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

Update Action

The update action is used for posting information into the timeline which can be used for collaborating with your team members.

Links and Embedded Content

The update supports text, images, and embedded multimedia/hyperlinks. Simply cut and paste the content, or link you wish to share in the update box. Examples include:

  • Sharing a youtube video, which can be viewed in the update from the timeline of the request.
  • Links (URL) to another request, workspace post, or document in Hornbill.

Wiki Mark-Up

For easy formatting of content, a sub-set of Wiki Markup can be used for decorating text, with italics and bold, creating bulleted or numbered lists etc. Use Ctrl+I or Ctrl+B keyboard shortcuts to enable/disable italic and bold text as you type.

Mentions

It is possible to @mention a co-worker in an update. The mentioned co-worker will receive a Hornbill notification that includes a link to the request.

Customer Email Notifications

Email notifications can be sent to the customer of the request each time an Update is added with the visibility level of Customer. These emails can contain links back to originating request to allow the customer to read and respond to the updates. Subsequent comments that are made below a customer visible update will also provide an email notification to the customer This is a great way to keep the customer up to date.

Note

It is important that the following has been set up in order for the customer to receive the updates by email.

  • Service Mailbox
    Set a default mailbox on the service and/or on the Request Types for the service
  • Shared Mailbox Access
    Make sure that all the analysts that will be updating the request have access to the mailbox set on the service.
  • Default Email Template
    A default Email Template called CustomerTimelineUpdateNotification has been provide for you. Emails sent to customers will be based on this template. You can modify this email template to suite your needs.
  • Email Template Setting
    If you want to create a new email template for this purpose, update the system setting guest.app.requests.notification.emailTemplate.customerTimelineUpdate with the name of the new email template.
  • Email Notification Setting
    This setting guest.app.requests.notification.emailMailbox defaults to helpdesk on installation. This needs to be changed to the name of the mailbox that you wish to use for notifications from Service Manager.
  • Notify Customer Enable the Notify Customer option on the Request Action configuration.

Update Linked Requests

If there are linked requests associated to the request that you are working on, you are able to send an update to the Timeline of these linked requests

Setting

This feature is turned off by default and can be enabled in Service Manager Application Settings.

  • app.request.update.enableLinkedRequestAction
    Enable the option to update linked requests against a request through the Update tab.

Using

If there are requests linked to the request you are working on, the Update button within the Update Action will include an arrow that exposes the option to update the linked requests. Selecting the option to Update this and linked requests… will display a dialog box that lists the linked requests.

  • Select All
    Use this to select or deselect all of the requests in the list
  • Check Boxes
    Use the individual check boxes to select individual requests to include in the update
  • Request Type Filter
    Filter the list of linked requests to only show the selected type
  • Update
    Click to apply the update text to all of the selected requests

Tip

Updating linked requests is a one way update. If comments are made on the update in the linked requests, the originating request will not have visibility of these comments.

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