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

Complex Types - entityActionAutomationRunType

Description

This node is used to invoke any installed ITOM packages.

Properties

Name Type Occurrence Description
adminCredential xs:integer Optional admin creds id - to access target machine
continueOnError xs:boolean Optional
Default=false
If you set this to ‘true’ then the process will continue after any error without aborting the process.
description xs:string Optional Test to desribe what the node is doing.
extraCredentials sisExtraCredentialType Optional
Unbounded
If required, one or more extra credentials information.
integrationServiceId xs:integer Optional The site integration service id to deploy package through.DEPRECATED
packageId xs:string Optional The installed ITOM package id from installed packages table to run.
packageOperation xs:string Optional The operation within the package to run.
packageVendor xs:string Optional The vendor…used for UI propsheet filtering
parameter bpmFlowcodeParameterType Optional
Unbounded
The input parameters to pass to this orchestration operation.
resultReference xs:string Optional The context variable to put call result into i.e. “mycall” which would expose globals.sis.mycall
runAsCredential xs:integer Optional optional run as creds id - run actual job with these creds otherwise will use adminCredential
sisTarget xs:anyURI Optional The site integration group or service urn to deploy package through.
target xs:string Optional The target machine - relates to a record in the inventory table or to a list. For computer, either the computer name or ‘computer:’ or a list of computers ‘list:<list_id>’
timeout xs:unsignedInt Optional
Default=60
The amount of time (in seconds) to wait for the sis call to complete before a timeout is returned.
waitForCompletion xs:boolean Optional
Default=false
Wait for sis call to complete and return results to the context
In This Document