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

Libraries

Libraries represent an important way of sharing documents within your business. You can define multiple libraries, and document owners can publish their documents to those libraries. Libraries can then be made accessible to all or selected groups of users.

Creating Libraries

Hornbill: Document Manager – Managing Libraries Users with the MyLibraryManager role can create libraries, and can then assign user, groups and roles to each library to allow them to view documents in the library, add documents to the library or edit the details of the library.

From the Libraries menu option use the + Add Library option, provide a name for the library and optionally a description to define the libraries purpose. Adding Users, Groups and Roles A Library owner can select individual users, groups or users, or users who have a particular role. For each user, group or role they are giving access to the library they can decide what level of rights and access each has:

Can View This will allow users to only view the documents in the library Can Upload This will allow users to add documents to the library Can Edit Metadata This will allow users to edit the libraries metadata (attributes) Once Users have been added to a library, the library owner can manage their rights from within the Sharing list, by simply selecting or unselecting the rights for individual users, groups and roles.

Adding Documents to a Library Any user who has the rights to add documents to a library will be able to open a document and as long as the document is in an Active status, they will be able to view and use a Publish icon in the Document Action Bar. From here they can simply choose the library they wish to publish the document and click Publish.

Users can repeat this should they wish to add the same document to more than one library Users can see which libraries a document has been published too, under the Libraries section on the document properties Library Properties Each Libraries properties will show you:

Who the Library Owner is which Users, Groups and Roles the Library has been shared with, and their individual rights to the library If the Library has documents added to it, a Tag cloud will show you the Tags attributed to the documents in the library - clicking on a Tag will return the documents which carry that Tag. A Link to view all the documents which have been added to the Library Deleting a Library Deleting a Library will permanently remove it from the system.

Please note that this operation is not reversible. Deleting a library does not delete the documents that have been published to the library. Libraries in the Hornbill Portals

Libraries available in the Portal

Sharing the Library with the “Docmanager Portal” role Like the other Hornbill Applications, Document Manager offers the ability to present content in the Hornbill Portals. It is possible to make Libraries available in the Hornbill Portal by using the “Docmanager Portal” role. The simplest way to do this is as follows:

Create a Library that you want to expose to the Portal. Choose a suitable name to reflect the content of that Library. Remember, any individual documents that are ultimately published to this library are going to be available in the Portal.

Share this new Library with the My “Library Portal” Role. For Basic Users to see this in the Service Portal, the “Docmanager Portal” role must be associated to each Basic User who should view this Library. For Contacts to see this in the Customer Portal, the “Docmanager Portal” role must be associated directly to the Customer Portal Account The Customer Portal account can be accessed via Hornbill Administration Home > System > Manage Portals > Portal Accounts. Select “customer” and scroll down to the security settings section. In the Authorized roles section, add the “Docmanager Portal” role. Click “Save Changes”.

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