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

Complex Types - measureListItemType

  • Article
  • 2 minutes to read

Description

This type is used when returning a list of defined measures.

Properties

Name Type Occurrence Description
actual xs:decimal Optional The latest value for this measure. If the value is NULL then this element will not be present
application appNameType Optional The application this measure is associated with. This is only provided if there is no application filter applied
createdBy xs:string Required This is DEPRECATED and should not be used, USE createdByUserInfo INSTEAD Who created the measure.
createdByUserInfo accountBasicDetailsType Required Who created the measure.
createdOn xs:dateTime Required The date/time the measure was first created.
difference xs:decimal Required The change in value of “actual” from the previous value, this shows the last movement of the value.
highIsGood xs:boolean Required If this is set to ‘true’ then a value above or equal to the “threshold” value is good, if set to “false” then a value below or equal to the “threshold” value is good.
lastSampleTime xs:dateTime Required This is the date/time of the last sample taken.
measureFrequency measureFrequencyType Required Frequency at which the measure is taken.
measureId xs:unsignedInt Required The unique identifier of the measure.
scorecardLimit xs:unsignedInt Required The maximum number of values to show when displaying a scorecard.
sparklineLimit xs:unsignedInt Required The maximum number of points to use when sparkline.
status measureStatusType Required The current statis of this measure. If the status is ‘error’ then a descriptive error is provided in the statusError property.
statusError xs:string Optional If the status is set ot ‘error’ then this provides a description of the error that was encountered.
targetBreach xs:decimal Optional A measure can set a breach threshold in order to visualize good/bad status of the measure.
targetWarning xs:decimal Optional A measure can set a target warning level in order to visualize good/warning status of the measure.
timeZone xs:string Optional The Time Zone applied to this measure.
title xs:string Required Specify the name of the measure.
trendValue measureTrendValueType Optional
Array (0/∞)		 The latest values for this measure, ordered in cronological order with the newest value appearing first
unitType measureValueUnitType Required The type of meaning the value of the measure has.
updatedBy xs:string Required This is DEPRECATED and should not be used, USE updatedByUserInfo INSTEAD Who last updated the measure.
updatedByUserInfo accountBasicDetailsType Required Who last updated the measure.
updatedOn xs:dateTime Required The date/time the measure was last changed.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document