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

Variable Picker

The variable picker is available to use in most business process nodes and their fields, this includes:

  • Human Tasks
  • Custom Expressions following Decision nodes
  • Integration Calls
  • Automated Tasks
  • Authorisations The variable picker allows for the injecting or overwriting of variable values into node fields.

Using the Variable Picker

It is possible to manually insert variables into node fields and this is covered in the Request Variables section, here we are focusing on the use of the variable picker.

The Variable picker can be opened in one of two ways:

  • In most fields in business process nodes the Variable picker icon.png icon will be present and clicking on the icon will open the variable picker.
  • Select ctrl or cmd and left mouse click, this will also open the variable picker if it is available and the Variable picker icon.png icon is not displayed

The variables which are available to use will be governed by which nodes precede the node you want to use the variable picker on in your business process, and therefore what information (variables) are available to you.

Available variables:

  • Global Inputs
    This option will contain any globally available variables such as requestid
  • Flowcodes
    This will list any variable data related to the entity in which the variable picker is being used. In order to have options presented here, the designer must use the relevant business process Get information nodes in the process stage prior to the node they want to make the variables available in. Below is a list of the variable containers which can be used and their related Get Information node
    • Customer Details - Automated Tasks > Requests > Get Request Information > Customer Details
    • Organization Details - Automated Tasks > Requests > Get Request Information > Organization Details
    • Owner Details- Automated Tasks > Requests > Get Request Information > Owner Details
    • Request Details - Automated Tasks > Requests > Get Request Information > Request Details
    • Progressive Capture Answers - Automated Tasks > Requests > Get Request Information > Progressive Capture Answers
    • Service Details - Automated Tasks > Requests > Get Request Information > Service Details
    • Site Details- Get Request Information > Site Details
  • Tasks
    This will contain any tasks which precede the node into which you are looking to use the variable picker in the current stage of the business process. Task variables which can be used include:
    • Outcomes
    • Completion Details
    • Completion Date
    • Owner
    • Custom Field Answers
  • Integrations
    This will contain any output parameter variables which are returned from any integration nodes which precede the node you are looking to use the variable picker in the current stage of the business process

Inject or Overwrite

With the variable picker open and having navigated to the variable you wish to insert, you have two options to choose from:

  • Inject
    Clicking this option will add the variable to any other content which is currently in the node field (other variables, and or manual added content etc)
  • Overwrite
    Clicking this option will remove any existing content in the node field and replace it with the variable you have chosen.

The variable picker allows for the adding of one variable at a time and the above process would need to be repeated where multiple variables are required to be added to the same node field, using the inject rather than overwrite option.

Raw or Display Value

When choosing to inject or overwrite with a variable, it is possible to choose to use either the raw value or the display value of the variable. A good example of this is when you are configuring your progressive capture custom questions you may define a possible answer with both a value and a display value - these may be the same or they may differ. If you are creating different language versions of the question, you may want the raw value to remain the same but the display value may be different depending on the different language versions you have created, and as such you may choose to inject or overwrite with the display value rather than the raw value. The raw value will still be important elsewhere. You may make branching decisions in your process based on the raw value, as this value will always remain constant regardless of if the display value changes, this maybe the case depending on the users language settings or if you wish to edit how the display name is presented to the users in the future.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document