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

iBridge Package Reference

Introduction

Hornbill provides over 1000 integrations across more than 100 different cloud-based products out of the box as part of our Integration Bridge service (iBridge).

The Hornbill iBridge allows you to integrate automated tasks within Hornbill Workflows without the need to install or configure any on-premise software or make any firewall changes.

No additional configuration is required for the Hornbill iBridge out of the box - you will have access to our catalog of various integration packages as documented in this book. All Hornbill iBridge automation operations are provided with simple to use input and outputs that can easily be mapped into an existing workflow with a completely codeless design.

New integrations can be requested on the Hornbill Community Forum, and if accepted will be made available as part of our Continuous Delivery model.

How does it work?

It’s easy, and really only a two step process to get up and running:

Step One - Secure Credential Storage

Many of the Hornbill iBridge cloud automation operations will require some form of authentication. Hornbill provides a secure credential storage called KeySafe, which stores authentication credentials for all of the cloud services that we integrate with.

KeySafe holds all the authentication credentials securely so you don’t have to:

  • Keep re-entering them when wanting to use the integrations in your Hornbill Workflows
  • Expose credentials to workflow designers who want to take advantage of the cloud service integrations in their Hornbill Workflows

Step Two - Cloud Automation

Once the authentication credentials are configured, in the Workflow Designer you can use the Cloud Automation node as often as you like in your workflows to call and invoke the integrations with the cloud services which you have set up on your instance.

You won’t be asked to configure the Authentication details each time you want to use the Cloud Automation node in the Workflow Designer, you simply choose which stored authentication details to use for the cloud service and then configure the required input parameters for the cloud service automation, and you are done.

Premium Integrations

Some of the iBridge integrations provided by Hornbill are Premium Integrations, these are indicated by a icon in the workflow Cloud Automation Node pick list. These integrations require that you have an iBridge Premium Subscription on your Hornbill instance, which will give you unlimited access to all Premium Integrations.

Free Tier Use

By default, every customer has unlimited access to all free tier integrations, as well as a limited number of invocations of Premium Integrations. On the free tier, a maximum of 10 Premium Integrations can be invoked per calendar month, without requiring an iBridge Premium Subscription. This Free Tier access will allow for either testing or low volume production use of the iBridge Premium Integrations.

The 10 invocation limit is enforced, so if you attempt to use a Premium Integration more than 10 times in your Hornbill Workflows without an iBridge Premium Subscription, then your workflow will throw an error and fail.

Please contact Hornbill should you wish to add the iBridge Premium Subscription to your instance.

Cloud Integrations Disclaimers

Suitability of Third-Party Applications

Hornbill ensures that every integration operates as expected, meeting the specific technical standards required by each API or third-party system we connect with, in accordance to their documentation. However, Hornbill does not officially support or vouch for, or provide any warranties of performance and suitability of any third-party product, or its integrations for any specific purpose. We do not perform any evaluations regarding their appropriateness for certain tasks, services, or the companies offering these services. Our commitment is to the functionality and meeting the technical requirements of these integrations; beyond that, our role concludes. As a customer utilizing third-party services or APIs via our integrations, the responsibility to assess the data you exchange with these third parties, and to judge their suitability, dependability, and security measures falls to you.

Technical Support for Third-Party Applications

Hornbill does not have any expertise and cannot provide any kind of support for any third-party products (unless explicitly covered in any extended support agreement with you). Our integrations follow the guidance in the service providers API documentation. Our support and technical staff are not trained, or authorized to provide technical support or advice about the use, function or performance of any third-party services or applications. If you choose to use a one or more third-party services with integrations we provide as part of your deployment of Hornbill, it is your responsibility to have any required support arrangements with those third-party services.

In This Document