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

Attachment Action

One or more attachments can be added to a request through either dragging and dropping the files onto the attachment box, or using the Select Attachment option to browse to find and then select the files you wish to attach.

Attachment Action

Comments and Descriptions

Once your files have been added to the attach action, you can provide an optional comment which will be visible on the timeline of the request, which can be used to help explain why the attachments have been added. You also have the option to add a short description to each attachment.

Lock/Unlock

A user that has a Full Access role to the request type can lock this action. Locking this action will prevent other users from being able to upload an attachment. The locking and unlocking of this action can also be controlled by using Access Control in a workflow.

Visibility

Once you have selected your files and added any supporting comments and descriptions, you can choose the visibility level of the attachments. If this is set to Customer, it will allow the customer to view the attachments on the request via the customer or employee portal. If the setting is changed to Team, or Owner then the customer will not see these attachments when viewing the request.

Attachment Section

Any attachment that has been added to a request can be accessed from the Attachments section. The Attachments section is only visible when one or more attachments have been added.

Attachments Section

Downloading

By clicking on the name of the attachment, it will be downloaded to your local computer. Browsers generally have settings to control the location and behavior of the downloads.

Image Preview

If an attachment is recognized as an image, an image icon appears next to the attachment’s name. Clicking on this icon will display a preview of the image without having to download it.

Actions

Each attachment has an Actions menu where the following can be done

  • Edit Description
  • Edit Visibility
  • Remove (Permanently delete the attachment)

System Settings

Restrictions can be applied to both the type of files that you want to allow to be uploaded and the maximum size of any individual attachments that are being added. These can be managed by your administrator through configuration.

Name Description Default Setting
communications.maxfileUploadSize Sets the maximum size (in bytes) of a file upload 1000000
security.fileUploadRestriction.webdav.types This is a semicolon(;) separated list of the restricted file extensions (without the dots(.)) for file upload exe;bat;cmd;js;vbs
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document