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

Organization

The Hornbill platform allows for the creation of a hierarchical structure that represents your organization. Create and manage your organization’s groups and teams, and the members that belong to them. Some examples of the different group types include companies, divisions, departments, and cost centers.

Topics covered

  • How groups are used
  • Manually adding groups
  • Planning the group structure
  • Adding users to groups

Before you begin

  • Admin user access is required
  • Knowledge of the existing structure of your organization
  • You should fully understand how the Hornbill Platform supports an organizational team structure
  • You should fully understand how the organizational and team structure works with Human Tasks

How groups are used

The organizational data is used by the different Hornbill apps to identify groups of users for several purposes. Some examples of these include

  • Email notifications to group members within a Business Process Automation
  • Authorization by a group within a Business Process Automation
  • Service subscriptions within Service Manager
  • Knowledge base access within Service Manager
  • Group based reporting
  • Home Groups for unique user experience in the Employee Portal

Groups vs Teams

  • Groups
    Use groups to build your organizational structure along with the associated people that belong to each group.
  • Teams
    Use teams for associating subscribed users that work together within the different Hornbill apps.
Feature Group Team Function
Can contain sub-groups Yes No No
Associate Basic Accounts Yes No No
Associate User Accounts Yes Yes Yes
Allow Task Assignment No Yes Yes

Adding a group

From the organization view click on the + Create New Group button.

  • Organization Id
    This is the unique identifier for this group.
    • This value can only contain letters, numbers, and underscores
    • It cannot begin with a numeric digit
    • Must be at least two characters long and is limited to a maximum of 160 characters

    Note

    Please be aware, that once the ID has been saved, it cannot be amended. If this new group has a parent, then the ID will be constructed using the ID that you specify as well as being prefixed with the ID(s) of any parent groups.

  • Name
    This is the user-friendly name for the group. This can be amended at any time after the group has been created.
  • Parent
    This is how the hierarchy is defined. Here, the direct parent of the group should be specified. For example, if creating a division, a company group may be selected as a parent. Be aware, that once the parent has been saved, it cannot be amended.
  • Type
    This is a drop-down list, specifying the type of group that is being created (Company, Division, Department, Costcenter, Team, or General)
  • Attributes 1 to 9
    These fields can be used to store additional information.
  • Notes
    A free text field to record any additional information regarding the group.

Tip

Reporting - Groups are stored in the table h_sys_groups and the types described above are represented by an integer value between 0 and 5 in a column called h_type. These are as follows: 0=general, 1=team, 2=department, 3=costcenter, 4=division, 5=company. The group type may be useful when creating measures, widgets, and reports.

Associated users

Once a group has been created, users can be associated to the group.

  1. Click the group in which the user(s) need to be associated with
  2. Click the Associated Users Tab
  3. Click the Associate User button. A form is displayed with the following options:
  • Search Users,
    Begin typing the name of an individual user to assign to the group, and click the name to select them
  • By Organization
    If the assigned users of the group need to be the same as another existing group, use this field to search and select the group. This will add all the members of that existing group to your new group.
  • By Role
    If the members of the group can be selected based on a common Hornbill Security Role, use this field to search and select the role. Any user who possesses that role will be added to your new group.
  • Membership Select whether the user is a Member, Team Leader, or Manager of the group.

Tip

BPM Automations can be used to add and remove users from groups. This can be useful as part of any workflow that manages new or leaving staff.

Allow task assignments

This option is only available for Teams. Having the Allow Task Assignments set to Yes on a team makes the team name available on the task form for assignment.

Associated user task management

  • Allow task view
    From the Task View, users with this option can see tasks that are assigned to their group.
  • Allow task action
    From the Task View, users with this option can action the tasks that are assigned to their group, such as assigning the task to themselves or completing the task.

Advanced settings

Setting Name Description
task.onlyManagerCanAssignGroupUser If this is set to true then only group manager can assign a task to a user which is already assigned to group.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document