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

Service Documents

Documents that are held within Document Manager can be associated to a Service. This is designed to provide document access to the subscribers of the service through the Customer and Employee Portals.

It is important to ensure that the documents linked to the service are held within a library that has been configured for access on the portals. Linking a document that is held in a library that is not configured for portal access will result in the document being listed, but not accessible by the service subscriber.

Sharing a Library with the Portals

The option for sharing libraries is managed from within the Document Manager app.

  1. From the main Hornbill Tile Menu, select Document Manager -> Libraries.
  2. From the list of libraries, find the library that you would like to make available to the portals and select Properties.
  3. On the Share option start by selecting Role and then search for the Docmanager Portal.
  4. Select Can View Library Contents and then click Share.
  5. Repeat for each library that you would like make accessible on the portals

Library Visibility Options

On the Library properties, visibility can be controlled so that a library is only visible to customers when viewing the Service details. By default, a library is visible within the Portals’ Library List. In order remove the library from the library list and only have it show associated documents on the Service form, the two following options in Document Manager Libraries need to be un-checked.

  • Show in User Library List
    Untick to hide the library in the employee portal and collaboration, this will only take effect if the user has been shared the library with read-only access (users with modify permissions will still be able to see this library). You will still be able to share documents in this library with users with read only permissions by giving them a direct link to the document
  • Show in Customer Portal Library List
    Untick to hide the library in the customer portal, (the library must be shared with a guest role before it can be accessed in the customer portal). You will still be able to share documents in this library with customers even if this setting is unticked by giving them a direct link to the document.

Adding a Document to a Service

On each Service form within the Service Portfolio, a Documents option lets you browse the list of all documents that belong to a particular library and link or unlink documents to the service. This action only be performed by the Service’s owner.

  • Select Library
    Select from the list of available libraries that you want to browse
  • Order By
    To help locate a document, you can change the order of the list by
    • Title
    • Owner
    • File Type
    • Creation Date
    • Updated Date

Each document will have a Link option. When clicked, this will associate the document with the service. Documents already linked to a service ill have an option to Un-link. When clicked, this will remove the document from the service.

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