Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


/ data / entityAddRecord


This method is used to add a record to an entity (business object). The server takes care of the database specific SQL syntax.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The entityAddRecord method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
application appNameType Optional Specify the name of the application this operation relates to. If not specified then “system” is assumed.
entity simpleIdType Required The name of the entity you want to add a record to.
returnModifiedData xs:boolean Optional
Set this to ‘true’ if you want to return a copy of all modified data.
formatValues xs:boolean Optional
Set this to ‘true’ if you want to format the returned modified values based on your Application settings, Otherwise, raw values read from the database will be returned
returnRawValues xs:boolean Optional
This is an optional parameter, the default value is ‘false’. If you specify true, then the returned modified data will include raw values for columns that have been formatted. The raw values are returned as an attribute in the corresponding column value called “raw”. The raw value will only be present if: -

- The value has been formatted and is now different to the raw value
- The column is not a TEXT or BLOB data type
primaryEntityData entityPrimaryDatasetType Required Primary entity data. Its values support CDATA.
relatedEntityData entityUpdateDatasetType Optional
Array (0/∞)
Related entity data. Its values support CDATA.
indexHoldOffTime indexHoldOffTimeType Optional
The amount of time (in seconds) to hold-off adding to the index. If zero is specified then this operation will add the document to the index and return when it has completed. IMPORTANT NOTE: In practice, even if you specify a index hold-off time of zero this operation is still asynchronous which means the update may be deferred if there are other transactions pending and being applied too. If you specify a value greater than zero then the document is added to an in-memory queue and returns to the called, the document is then held in the queue for the number of seconds specified before being committed to the index. This effectively makes the operation asynchronous. It should be noted that when using a indexHoldOffTime the document you are adding to the index will not be found in any subsequent search until the indexHoldOffTime has been reached.

Response Parameters

Name Type Attributes Description
primaryEntityData anyDataType Optional Primary entity data.
relatedEntityData anyDataType Optional
Array (0/∞)
Related entity data.
auditTransactionId xs:string Optional The GUID of the API request used to record data audit trail records
primaryEntityKeyValue xs:string Required Primery entity record id.
In This Document