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

KeySafe

Hornbill KeySafe provides secure encrypted storage for various types of authentication credentials, API keys and certificates. KeySafe records store credentials and different record types implement specific authentication schemes used by Hornbill’s integration, automation and data import capabilities.

Go here for more detailed explanation of KeySafe

Before you begin

  • Admin access or a user that has a role that contains the manageKeysafe right.
  • Knowledge of Hornbill integrations, API usage, workflows and auto tasks.

How KeySafe is used

KeySafe acts like a system-wide credentials manager for a wide range of integrations, connections and automation functions including: -

  • Cloud integrations within Hornbill Workflow and Auto Tasks.
  • ITOM modules that require credentials
  • Email Integrations that require OAuth configurations and setup
  • External/custom integrations, import tools and anything else connecting to a third-party where machine-to-machine authentication and security is required.

Credential Types

Hornbill KeySafe implements a large number of pre-created credential Types. External services and cloud applications that Hornbill integrates with are implemented. When creating a new KeySafe record, you choose the type you want to create and the correct fields and/or user interface will be presented for you to complete.

Generic KeySafe Types

To support authentication to external systems, generic authentication types are provided to allow KeySafe entries for integration outside of the provided specific KeySafe types.

  • API Key
    Authentication that requires an authentication key to make a secure connection.
  • oAuth 2.0
    Create an entry that uses standard oAuth 2.0 authentication.
  • HTTP Basic Authentication
    Connect using basic HTTP authentication using a user name and password.
  • HTTP Digest Authentication
    Connect with a user name and password, but with added security over basic authentication.
  • Database Authentication
    Connect to a database system such as Microsoft SQL.
  • User name + Password + Pre-shared key
    Basic username and password authentication with an added security of a pre-shared key.
  • SSH Private Key
    Uses two related keys, a public key and a private key, that together create a key pair that is used as the secure access credential.

Service Specific KeySafe Types

The Type list includes many predefined services that Hornbill integrates with. Each of these types contains attributes that are required to authenticate to that service. If you are looking to integrate with an external service, check first to see if there is a type available for that service.

KeySafe API Rules

When using KeySafe credentials from an external integration that uses an API key you are required to define a rule on the KeySafe record that grants explicit permission to the API Key or User account to allow access the KeySafe record and its stored credentials. This ensures that only the configured integration is able to access the KeySafe credentials for one or more specific KeySafe records.

Using KeySafe in a Workflow

Using KeySafe entries as part of a business workflow is a great way to securely connect to external services.

This is achieved using the Cloud Automation node in a workflow

  1. Open the properties of the Cloud Automation node.
  2. On the Method field select the edit icon.
  3. Browse the list of services and select an action that you would like to perform.
  4. Under Request Credentials select an existing KeySafe entry that will be used to authenticate to the service.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document