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

User Roles

A Role is a collection of rights that allow a user to perform actions in Hornbill. Hornbill comes with a range of roles ready for you to assign to your users and custom roles can be created to meet your specific needs.

In addition to platform roles, each application comes with roles specifically designed to govern access to that application.

Topics Covered

  • Describing the different types of roles.
  • The different ways to assign roles to users.
  • How roles can affect application subscriptions.
  • How to create a custom role.

Before you begin

  • Users with the Admin or Super User role can manage roles
  • The rights Manage Role, Create Role, Delete Role, and Update Role are available for custom roles.

Role Types

Two types of Roles exist within Hornbill, Security Roles and Assignment Roles:

  • Security Roles
    Are used to control access to Hornbill Applications and to the different areas within each application. Security roles have a “Privilege Level” which determines the level of access provided to users that are assigned to the role.
  • Assignment Roles
    Provide restrictions on the assignment of Activities. For example, when configuring a Human Task node within a Business process, it is possible to assign that task to a Role. This is especially useful if you wish to restrict the assignment of an activity to several users within a particular group or if you want to expose this activity to a selection of users across multiple groups. It is also possible to share certain items based on an assignment Role. One example is Dashboards. Assignment Roles can only be associated with application Users"

Privileges

Security roles use the following privileges to control the level of access for a user that has been assigned to the role.

Privilege Level Description
None This privilege level has no privileges assigned.
Guest This is the privilege level applied to any guest account login via a customer/external portal session.
Basic This privilege level is associated with basic user accounts. The basic user privilege level provides very limited access to the Hornbill platform, typically this type of user would be an employee that does not use Hornbill on a day-to-day basis, but uses the Employee portal to access services being provided.
User This privilege level is typically associated with a normal user account.
Admin This privilege level is in effect a ‘super user’ account. This privilege level is used sparingly, and should not be used for day to day user accounts.

Tip

A user’s overall privilege level is determined by the highest privilege level of all their combined roles.

System Roles

There are a number of roles that are provided with Hornbill. These roles are read-only and contain a set rights for performing a particular set of tasks. Additional rights cannot be added.

System roles can be easily identified in the list of roles by the closed padlock icon.

User Created Roles

If the roles that come with Hornbill do not meet your specific needs, you can create your own roles.

Creating a Custom Role

  1. Open Configuration
  2. Select where the new role will be created (either Platform Configuration or a specific Hornbill App) from the drop down menu.
  3. Select Roles in the left-hand navigation panel.
  4. Select + Create New Role from the top right-hand toolbar.
  5. Provide a Role ID (must be unique), Privilege Level (only required when creating a security role), Type, and description.

Tip

  1. If you create a role under the platform configuration, you can add or update the application context or tie the role to a Hornbill Shared Mailbox.
  2. If you create a role under an application configuration you cannot assign it to other applications or mailboxes.
  3. Users can be allocated subscriptions through role assignments. If you assign a user to an application role that has a privilege level of user a subscription will be allocated to that user when they next log in.

System and Application Rights

  • System Rights
    All roles have the option to add system rights.
  • Application Rights
    This will only be available if the role is associated to an application. Only the rights for the associated application will be available.

Data

Name Description
Manage Lists Provides read access to the Simple Lists under Platform Configuration and with each application where the user has a subscription. Additional rights are required to be able to create, update, and delete lists
Add Lists Add a new simple list. Requires the Manage Lists right
Update Lists Update an existing simple list. Requires the Manage Lists right
Delete Lists Delete a simple list. Requires the Manage Lists right
Manage Profile Categories
Create Profile Categories
Update Profile Categories
Delete Profile Categories
Add Profiles
Update Profiles
Delete Profiles
Manage Scheduled Jobs Allows the user to view their own scheduled jobs within the user app. Users that have a privilege level of admin will also be able to view all users’ scheduled jobs from within Configuration and reassign the owner of a job
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document