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

Unified JSON and XML Message Format

  • Article
  • 3 minutes to read

TODO:…

Working with XML and NULL values

When making an API call using the XML format where you are required to represent a NULL value, we follow the de facto standard for XML using a special attribute/value pair xs:nil="true". This is not strictly part of the XML specification or the XML Schema specification, but seems to have originated from uses in the XSLT template language. In any case, for the Hornbill API when using XML representation, we use this form to indicate a NULL value.

xs:nil="true" is an attribute used in XML schema (xs namespace) to indicate that an element has no value. It is used in situations where the element should have a value that is required by the schema, but no data is available. The “nil” attribute, when set to “true”, specifies that the element is nil, i.e., it has no value. This allows for a distinction between an element that is present but has no value, and an element that is absent.

For example, if an element named “PhoneNumber” is required in an XML document, but no phone number is available, the element can be declared like this:

<PhoneNumber xs:nil="true"/>

This means that the element exists, but it has no value. This can be useful in situations where the presence of the element is required by the schema, but no data is available to fill it.

For APIs that map data from the API call to a database, there are four possible values for any given column

  • [1] No Value Provided - self-evident, if you do not provide a value then, assuming is optional the bound column is simply left alone.
  • [2] A Value - a specific and valid expected value is provided.
  • [3] Empty Value - for types like xs:string and xs:base64Binary, it’s possible to provide an empty string.
  • [4] A NULL Value - for most types, a NULL value is distinct from a value, and in the case of a string type, is distinct from an empty string. A NULL value is a value that is present but has no specific value.

The key here is it is possibly to identify these four specific states, not present, no value, an empty value and a value that is NULL.

Example XML Values (including NULL)

The following examples show the correct way of sending values via XML


<!-- Example [2] -->
<param>Some Value</param>

<!-- Example [3] - An Empty Value, Value is present but contains no content-->
<param></param>
<param/>

<!-- Example [4] - A NULL Value (two variations) -->
<param xs:nil="true"/>
<param xs:nil="true"></param>

There are a number of common incorrect variations in use. These are all wrong and will either not work or exhibit undefined behavior.


<!-- Invalid/wrong ways of NULL values -->

<!-- A common source of bugs, typically occurring from errors in the 
     front-end/browser code, or in FlowCode JavaScript, and happens because
     a value is sent from a variable object reference. -->
<param>undefined</param>

<!-- missing namespace when defining a NULL value -->
<param nil="true"></param>

<!-- this is most likely an unexpected behavior. In this case NULL is a string value "NULL" -->
<param>NULL</param>

<!-- incorrect namespace (xsi), only the ***xs:*** namespace is supported -->
<param xsi:nil="true"></param>

Note

It is important to understand that not all APIs or input parameters universally support providing a NULL value. If you are unsure refer to the specific API’s documentation for detailed information.

XML Schema Validation

An element may be valid without any content if it has the attribute xs:nil with the value true. An element so labeled must be empty.

When deserializing an XML document into an object, if we encounter an XML element that specifies xs:nil=“true”, it assigns a null reference to the corresponding object and ignores the element value.


<!-- Example 1 -->
<param xs:nil="true"/>

<!-- Example 2 -->
<param xs:nil="true"></param>

<!-- Example 3 -->
<param xs:nil="false"></param>

<!-- Example 4 -->
<param></param>
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document