Documentation

{{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}}

Employee Portal Configuration

The Employee Portal is a highly configurable environment where you can add widgets and enable features for your employees to be able to access their services, communicate with the Service Desk, submit and view requests, chat with support staff, and access shared documents.

Topics covered

  • Basic configuration for the employee portal
  • How to enable the portal
  • Different company configurations

Page sections

The Employee Portal pages are split into three sections: header, body, and footer.

Employee Portal Sections

Header

  • Logo
    Add your company logo to the Employee Portal to give it some branding. Your logo will be displayed on the left side of the header. Adjust the size, background style, and color of your logo to fit in with the Header Background. The size depends on many factors but to give general an idea; The height can be between 80 and 200 pixels and the width between 80 and 300 pixels. It can be of any web format but PNG or SVG is recommended.
  • Background
    The Header Background can be configured to set the height and the color, or add a background image. The size depends on many factors like if the background is a pattern or if it has details, but to give general an idea; 1024 x 300 pixels. It can be of any web format such as JPEG or PNG
  • Text
    The Text on this page includes the main title of the page and the list of different Service Domains which are displayed within the menu bar.

Tip

Images used for the logo and header background require a URL or link to an image that is stored in a location that is accessible by all users, such as a company web server or the Hornbill Image Library.

Body

  • Background
    Options to either set a background or apply an image to the main body of the portal. The size depends on many factors like if the background is a pattern or if it has details, but to give general an idea; 1024 x 768 pixels. It can be of any web format such as JPEG or PNG.
  • Section
    Sets the default colors for the widgets that are added to the page
  • Popup
    Sets the default colors for popup boxes

Footer

  • Style
    Set the color and font options to use within the page footer
  • Social Information
    This section allows you to specify your social media accounts Twitter, LinkedIn, YouTube, and Facebook. Only the account ID is needed. We’ll take care of the links. These are displayed with the appropriate social media logo. Any logo that you do not want to display, leave the account name blank. If you would like to completely remove this section, deselect the checkbox next to the Social Information title.
  • Contact Information
    Add the contact details to let you users know who to contact if they have questions about the page. Any field that you do not want to display, leave blank. If you would like to completely remove this section, deselect the checkbox next to the Contact Information title.
  • About Details
    Add a bit of information for your users to describe this page. If you would like to completely remove this section, deselect the checkbox next to the About Details title.

Tip

By deselecting all three checkboxes, you can completely remove the footer from the page.

Company

When a company is made up from of a number of subsidiary companies, you are able to define this structure within the Hornbill Organization Structure using company Groups. Each defined company group can have its own settings applied in order to provide there own unique branding. On the top of the settings form, you can select one of the available companies that you have defined in Hornbill.

  • Primary Company
    This is the main configuration for the Employee Portal. It will also be used as a template for any Company that is defined within the organization structure. Settings here will be automatically applied to all other companies unless a company has specified a different setting from the Primary Company.

Tip

A new attribute called Home Organization has been added to the User Account which can be set on the Organizations tab for that user. Setting the Home Organization for a user will have them directed to the appropriately branded page for their company. When a Home Organization is not configured for a user, the Primary Company settings will be used. User imports can also be changed to automatically set the home organization

Settings

These setting can plan a key role in how you first introduce the Employee Portal to your users. Make sure you are familiar with these settings and when to use them.

  • Users to preview the Employee Portal
    This is an important first step to setting up your Employee Portal. This setting allows you to add a list of comma-separated user names of people you want to have access to the Employee Portal. This gives you the opportunity to have one or more people to test and feedback on the Employee Portal design before you open it up to all users. Changing this setting will also be one of your last steps. Once you have completed your configuration and you are ready to make it available to all users, simply remove these names. Once the list of names is empty, it becomes available to everyone.
  • Enable Employee Portal
    Turning this setting to On will make a new navigation menu item My Company available in the Home menu on the main Hornbill web app. If you have provided one or more names in the previous setting, only those users will see the menu item.
In This Document