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

Entity API / logKnownError

Operation Information

  • Application Reference: com.hornbill.servicemanager
  • Scope: Entity - KnownErrors
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group B - createKnownErrors

Description

This flowcode operation logs a Known Error using the provided parameters. Firstly it calls the component flowcode operation logRequest to log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.

Request Parameters

The logKnownError API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
summary xs:string No Summary of the known error
description xs:string No Description of the known error.
requestType xs:string No The type of request (Known Error).
customerId xs:string No The customer Id (Co-worker / Contact). If the customer is a co-worker, the id will be their login name. If the customer is a contact, the id will be the h_pk_id value of their record in the h_sys_contact table.
customerType xs:string No The customer type (Co-worker / Contact). 0 for a co-worker, 1 for a contact.
ownerId xs:string No The co-worker ID of the owner of the known error.
teamId xs:string No The Id of the team assigned to the Request. This is the h_id value of the record in the h_sys_groups table for the assigned team.
employeeAssignmentId xs:string No The Id of the employee assignment assigned to the Request.
status xs:string No The status of the known error, i.e status.open or status.closed. When not supplied, the value "status.new" is considered.
priorityId xs:string No The ID of the chosen priority for the known error.
categoryId xs:string No The ID of the chosen category for the known error.
categoryName xs:string No The Name of the category
image xs:string No WebDAV path to an image (from email only).
sourceType xs:string No The source from where the known error was raised (e.g. Email / Post).
sourceId xs:string No The ID of the source object the known error was raised from (if Email:messageId, if Post:ActivityStreamID and ActivityID).
assetId xs:string No The ID(s) of all assets to be associated to the known error.
impact xs:string No The impact of the known error. E.g. High, Medium, Low.
urgencyId xs:string No The ID of the request's Urgency level
serviceId xs:string No The id of the selected service. This will be used to spawn a bpm process.
questions xs:string No Questions that were answered during progressive capture
resolutionDetails xs:string No Details of how the error condition was resolved.
rootCause xs:string No The steps leading to the error that was observed.
stepsToResolve xs:string No The resolution details of the known error if it is to be raised and resolved at the same time.
fileName xs:string No The full path for the file(s) to be attached.
siteId xs:string No ID of the site this request is affecting
siteName xs:string No Name of the site this request is affecting
catalogId xs:string No The Catalog Id the Request was raised against
catalogName xs:string No The Catalog Name the Request was raised against
externalRefNumber xs:string No This parameter is to be set with the External Reference Number of a Request.
bpmName xs:string No The custom BPM Name when raising a request via a customised Service Catalog
questionFieldMap xs:string No Question Field Map as JSON
connectionMap xs:string No Connection Map as JSON
connectionUpdateTimeline xs:boolean No Update timeline true/false
connectionTimelineVisibility xs:string No Visibility level of timeline updates for added connections. Timeline update visibility defaults to Team if not provided.

Response Parameters

Name Type Description
requestId xs:string The id of the new known error.
bpmProcessId xs:string The id of the spawned BPM process for the new known error.
exceptionName xs:string The name / code of any exception thrown during the creation of the known error.
exceptionDescription xs:string A description of any exception thrown during the creation of the known error.
summary xs:string The provided summary of the known error.
warnings xs:string Any warnings that were encountered when logging the known error.

Code Examples

In This Document