Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.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.

Accessing

or

  1. Open Configuration and select Platform Configuration
  2. In the navigation panel locate the section titled Customize
  3. Select Employee Portal

Each area of configuration is accessed using the options across the top of the page.

Employee Portal Customization

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 height can be between 80 and 200 pixels and the width between 80 and 300 pixels. It can be in any web image format, but PNG or SVG is recommended.
  • Background: The Header Background can be configured to set the height and color, or to add a background image. The recommended size is 1024 x 300 pixels; however, the ideal size depends on factors such as whether the background is a pattern and what details are included in the design. It can be in any web image format, such as JPEG or PNG.
  • Text: The color settings apply to the header text, which includes the Name, the Short Description of the page, and the list of different Service Domains that are displayed within the menu bar. The background color of the domain menu bar can also be set here. (The displayed text can be configured when designing the Employee Portal).

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 color or apply an image to the main body of the portal. The recommended image size is 1024 x 768 pixels; however, the ideal size depends on factors such as whether the background is a pattern and what details are included in the design. It can be in any web image 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.

Company

When a company is made up of several subsidiary companies, you can define this structure within the Organization configuration using company groups.

Each defined company group can have its own Employee Portal settings applied to provide its unique branding.

At the top of the Header, Body, and Footer configuration sections, you can select the company to be configured.

Company Customization

  • Primary Company: This is the main configuration for the Employee Portal. It will also be used as a starting 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 configured to automatically set the Home Organization.

Mobile

Hornbill provides a Progressive Web App (PWA) to give users a fast, UI-rich way of accessing the Employee Portal. The mobile app can be accessed by opening a browser on the mobile device and navigating to mcatalog.hornbill.com/<Your_Instance>/.

Settings

Additional Core Settings can be configured to further change how the Employee Portal functions and looks.

Core Settings

Setting Description Default Value
app.view.core.header.autoHideHeaderForBasicUsers When set to ON, the Employee Portal header menu bar will be collapsed. A small tab is displayed at the top-center of the page which will expose the menu bar when hovered over. This only applies to basic users. ON
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document