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

Organizations

Introduction

If you deliver a service to organizations external to your own, you will store them in Hornbill as Organization records. They work in conjunction with contact records which can be associated to Organization records. Organization records can also be used to represent suppliers, or third parties. They operate externally to Hornbill so can’t collaborate but can request a service from you as a customer. Customer Manager allows organizations to be better managed so that you can improve the relationship you have with your customers.

Features

Organization List

Add an Organization

  • Organizations can be added using the + Create New button Complete the mandatory fields, and any optional fields. Select Create to add the organization.

Organizations List

  • You can configure the available display columns in the list to show the information that is important to you using the Cog Icon
  • Click on a specific organization record to view more information about that organization
  • Click on the File Box icon next to any organization you wish to archive

Searching Organizations

  • Quick Filter - Use to easily find a specific organization record, searching against their Name
  • Advanced Filter - Select the Funnel icon to expose additional search filters, including Industry, City, Country.
  • Archived - Use the File Box icon to filter the list to organizations which have been archived
  • Export - Use the Download Arrow icon to export the filtered list of organizations
  • Contacts - View Contacts for the listed organizations Global Search - with the filter switched to Organizations you can search for organizations by name, and see matching results displayed in the Organization list

Organization Record

Manage Organizations

From an Organizations record the following options are available to you

  • Archive - If an Organization is no longer needed, mark them as Archived. This will remove them from general Organization searches, but will still be accessible from the Organizations list and Archived Organizations’s option.
  • Contacts - View any existing organization’s contact’s and add new ones
  • Logo - Upload an organizations logo
  • Industry - The industry field uses a Simple List data. The list should be called Industry in the Collaboration app.
  • Region - The region field is hidden by default and it uses a Simple List data. The list should be called ExternalOrganizationRegions in the Collaboration app.

Plug-ins

Customer Manager

If Customer Manager is also installed on your instance the following additional functionality will be available against each organization

  • Activity Stream - Collaborate, Post and Comment on topics relating to the organization
  • Activities - Create and manage activities related to the organization, such as reviews
  • Members - Link internal staff to the organization and define their roles (Account Manager etc)
  • Documents - Search for an link documents held in Document Manager directly to the organization
  • Attachments - Upload and hold attachments against the organization (contracts etc)
  • Service Contracts (BETA) - Define service contracts, including supported items for the organization

Service Manager

If Service Manager is also installed on your instance you will see a list of requests which have been logged against each organization when viewing the organizations details

  • Manage which of the organizations contacts who have portal access, can also cancel service requests, and view requests raised from other contacts at the organization via the customer portal

Administration

  • Users with the Form Designer role, will be able to add custom fields, hide existing fields, edit their properties, and edit which sections of the organization record, fields are displayed in. This can achieved by dragging and dropping the fields into the required sections. With the Form Designer role, users will see a Design option to go into edit mode.
  • Custom Buttons - Create custom buttons on the organizations details. Typical use of organizations custom buttons could be to link to a document (held in Document Manager, or other externally accessible cloud solution)
    • To create custom button, define the required URL, add in the variable (if required), in the above example possibly a document id held in one of organizations custom fields, give it a title, tooltip, icon and color
In This Document