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

Request Catalog

The Request Catalog provide a structured way of promoting the available types of requests for a particular Service. Requests in the catalog are available to subscribed users of a service on the Hornbill Portals and can also be accessed by support staff to provide a standard way of raising a particular type of request.

Before You Begin

In order to create and manage the Request Catalogs the following user roles are needed to perform the different actions

Role Description
Services Manager Role Required to View and Access the Services forms where the Request Catalogs are created
Progressive Capture Manager Role Required to create and modify and Capture Scripts to be used with a catalog request model
Business Process Manager Role Required to create and modify any workflow to be used with a catalog request model.

Tip

By default Change Requests can’t be raised from the Customer or Employee Portal. Enabling the system setting: guest.servicemanager.portal.additionalRequestTypes.change will allow Changes marked wiht the visibility to Portal or Both to be visible on the portals.

Please beware that enabling this setting will also allow customers to see any historical changes that have been raised and they have been set as the customer of the Changes (even if no Change Catalog Items were used on the Change records).

How to Access

A request catalog can be created and managed for Incidents, Service Requests and Changes under the Request Configuration section of a Service.

  1. From the Service Manager application icon on the left hand menu bar, select Service Portfolio.
  2. From the list of services, select a service to view the details of that service.
  3. On the Service form select the Request Configuration tab.
  4. Select either incident, service request, or change from the available request types.
  5. Locate the section titled Reqeust Catalog.

Features

  • Title
    The name for the request, which will be displayed on the portals for customers, and to support staff in Intelligent Capture.
  • Description
    Provide information which describes the purpose of the request. This will be displayed on the portals for customers and to support staff in Intelligent Capture.
  • Intelligent Capture
    Select from defined scripts which can ask the customer or support agent pertinent questions when raising a request using this model.
  • Workflow
    Select which workflow will be invoked and followed when a request is raised.
  • Icon
    Select an icon which will represent the request in portals and in intelligent capture.
  • Visibility
    Decide if the request will be available on just the portals, or just to support staff, or to both.
  • Language
    Select the language that it is being written in. This will default to the language that is currently being used in the user’s session.
  • Statuses
    Draft
    Is not visible on the portals or in intelligent capture.
    Published
    Is visible on the portals or in intelligent capture.

Managing

The available Catalog Items are displayed in a list under the Request Catalog section. From this list there are three options available:

Ordering Catalog Items

It is possible to influence the order in which the Catalog Items will appear on the portals (under the Service) by dragging and dropping to reorder the Catalog Items. Managing Catalog Visibility - it is possible to configure which service subscribers can view each catalog item.

Update and Delete

  • Update
    It is possible to edit the details or status or to add additional languages to the Catalog Item by selecting the update Cog icon
  • Delete
    It is possible to permanently delete the Catalog Item by selecting the Delete Bin icon Information If this list is empty, subscribed users for this Service will not have an option to raise a request from the portals for this request type.

Intelligent Capture

The Request Catalog Items have been created in a way to allow each Catalog Item to be published to either Portal Users, Support Staff, or both. Publishing a Catalog Item to both of these groups enables a member of the support team to raise a request on behalf of a user while following the same steps that the user would experience in the portals. This ensures that the same information is captured no matter what the source is.

Service Details Form

The Service Details Form is required to give a support person the ability to select a Catalog Item when raising an Incident or Service Request. Selecting a service on the Service Details form will expose any available Catalog Items for that service.

  • If no Catalog Items have been defined, the Service can be selected and the current progressive capture will continue to run
  • If one or more Catalog Items have been defined, either the Service can be selected to continue with the current progressive capture or one of the individual Catalog Items can be selected which will run a new progressive capture that is specific to that item.

Portal Only Catalog Items

The creation of a Capture Script that is only going to be available to users of the portals is as straightforward as going to Administration and creating a collection of forms and questions that the user will be stepped through to raise the appropriate request.

When building a Progressive Capture Script for this purpose there is only one thing to keep in mind. There are particular progressive capture forms that are not designed for use by portal users. If these forms are added to these progressive capture scripts they will simply be skipped and not visible to the user on the portals. These include the following forms:

  • Customer Search
  • Co-worker Search
  • Contact Search
  • Service Details
  • Request Type
  • Customer Request Type
  • Analyst Assignment

Support Staff Only Catalog Items

When a support person begins the steps of raising a request, they will start by clicking on the Raise New option or selecting a particular type of request, such as an incident, or service request. Each of these will run its own capture script. Within any of these capture scripts the Service Details form may be included. It is this Service Details form that displays the Request Catalog for each Service. If one of these Catalog Items is selected, a new Progressive Capture Script will be launched.

It is possible that some of the information collected in the initial Capture Script will be relevant to the Catalog Model’s specific Capture Script. In order to maintain this information between the two Capture Scripts, the same Capture forms must be included in both scripts. For example if you use the Customer Search form in the initial Progressive Capture, and you want to retain the selected customer in the next script, the next script must also include the Customer Search form. If information collected in the initial script is no longer relevant to the Catalog Item, simply leave that form out of the Catalog Item script.

Shared Catalog Items

In some cases you may be able to use the same Catalog Item in both the Portal and the for the Support Staff. Using the considerations mentioned in the previous two sections, you can build a progressive capture script that lets you include Support specific forms that are skipped and not visible in the portals, but they can be added to retain information that the support person needs.

Language

If you are working in a multilingual environment you can publish each catalog model in a number of different languages. Any user that has a matching language set against their profile will see this in their preferred language.

Add a Translation

The Language option provides a list of all of the different languages that this has been translated into. A new catalog model will only show the language that was selected at the time of creation. To add a new translation click on the Add Translation button which will expose the options for publishing this in another language.

  • Language
    Select the new language that you wish to add.
  • Translate
    Clicking this button will take the original title and description from the default language and automatically translate these fields using Google Translate. The title and description fields will be automatically populated with this translation. These fields can also be manually edited to either add your own translation or to correct any mistakes made by the automatic translation. Clicking on the Translate button will overwrite any information that is already held in the title and description fields.

Update a Translation

  • Delete Translation
    Clicking on this button will delete the language translation that is currently selected in the language pick list. The default language translation cannot be deleted, therefore this button in not available when the default language is selected. The default language is a fallback and is displayed to a user who is using a language that does not have an associated translation available.
  • Update
    If a manual change has been made to either the title or description fields, to save these changes by clicking on the Update button
  • Preview Google Translate
    This is a sub-action of the Update button which is accessed by clicking on the arrow next to Update. This will translate the title and description fields using the default translation without saving it. This preview can then be saved using the main Update button.
  • Update with Google Translate
    This is a sub-action of the Update button which is accessed by clicking on the arrow next to Update. This will automatically translate and save the title and description fields.
In This Document