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 Profile

The user profile is made up of a number of sections, each containing a collection of related fields. These fields can be customized to your requirements.

Topics covered

  • Accessing the user profile designer
  • How to design the user profile
  • The different types of sections
  • Field properties

Section access

The user profile is separated into 5 sections with the default names of:

  • Basic Details
  • Job Details
  • Contact Details
  • Interests & Expertize
  • Personal Details

The bottom three sections have an option that allows a user to decide if they want to share this information to other users when they view their profile. Each user can select if these sections are public, accessible by followers, or private.

This is important when designing this form as any field that must be displayed to all users needs to be in the top two sections.

Note

Despite the visibility of the information in these bottom three sections being controlled by the user, apps may have access and the ability to use this information outside of the user’s profile.

Designing the form

To start designing the form, a single button called Design needs to be clicked on.

Moving fields

To change the order or location of a field on a form, use the mouse by pressing and holding the left mouse button on any part of a field and then drag and drop the field to a new location.

Because the visibility of the bottom 3 sections can be controlled by the user, there may be a need to move a field from one of these sections into the top two sections. Using the mouse, press and hold the left mouse button on any part of the field and drag and drop the field onto a different section.

Changing field properties

Each field on the user profile has a number of properties that can be changed. These properties are accessed by clicking on the cog icon located on each field when in design mode.

  • Hide or show the field
  • Make it mandatory
  • Make it read-only
  • Add input validation

User profile field properties

Labels and Translations

As part of designing the user profile form, you may want to change some of the labels or provide translations into different languages. There are three different ways to achieve this.

  • Within the properties of a field you can change the field label. This change will apply only to the language that you are currently using. By changing your session language you can update the translations for that language.
  • Enable Translation Mode. This give you a more flexible means to change the field label into other languages directly on the user interface. This method also provides an option for suggested translations.
  • Update the translations using the User Interface Translations

Tip

Many aspects of the user interface are cached for performance. In some cases a browser refresh may be required to see these changes.

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