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

Description

This type defines properties of a related entity

Properties

Name Type Occurrence Description
dynamicRelatedEntities entityDynamicRelatedEntityType Optional
Array (0/∞)
Fields for DynamicOneToOne reference type
dynamicValueColumn xs:string Optional Fields for DynamicOneToOne reference type
entityName xs:string Required The name of the entity
foreignKey xs:string Required The name of the column in the primary (referencing) table that identifies record(s) in the related entity. To clarify this see here http://en.wikipedia.org/wiki/Foreign_key for more detail
leftColumnName xs:string Optional Fields for SelfManyToMany reference type
linkingTableName xs:string Optional Fields for SelfManyToMany reference type
managed xs:boolean Optional
Default=false
Indicates that the related record is managed by this entity. If set to ‘true’ then the related record will be deleted when the primary record is deleted
mandatory xs:boolean Optional
Default=false
Indicates that the related record is mandatory when creating a primary record. In other words, when a primary record is being added/edited any relationships ManyToOne must exist
mappedValue entityMappedValueType Optional
Array (0/∞)
Mapped/copy values from the related table back to the primary entity table
referenceKey xs:string Required The name of the column on the related (referenced) entity that is used to identify it’s relationship with the primary entity
relatedEntity xs:string Required The entity that is related to the primary entity
relationshipName xs:string Required The unique name within the primary entity of this specific relationship
relationshipType entityRelationshipType Required The type of relationship this entity has with the primary entity
rightColumnName xs:string Optional Fields for SelfManyToMany reference type
In This Document