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

  • Article
  • 1 minutes to read

Description

Information about a report run.

Properties

Name Type Occurrence Description
csvFileSize xs:unsignedInt Optional The size of the CSV document created. This is DEPRECATED and should not be used, USE reportRunOutputFileType INSTEAD
csvLink xs:anyURI Optional The location of the CSV report output, the actual location in webdav or other reachable HTTP location. This is DEPRECATED and should not be used, USE reportRunOutputFileType INSTEAD
description xs:string Optional The description provided when the report was run
htmlFileSize xs:unsignedInt Optional The size of the HTML content created. This is DEPRECATED and should not be used, USE reportRunOutputFileType INSTEAD
htmlLink xs:anyURI Optional The location of the HTML report, the actual location in webdav or other reachable HTTP location. This is DEPRECATED and should not be used, USE reportRunOutputFileType INSTEAD
pdfFileSize xs:unsignedInt Optional The size of the PDF document created. This is DEPRECATED and should not be used, USE reportRunOutputFileType INSTEAD
pdfLink xs:anyURI Optional The location of the PDF report output, the actual location in webdav or other reachable HTTP location. This is DEPRECATED and should not be used, USE reportRunOutputFileType INSTEAD
publish xs:boolean Optional Optionaly Publish the Report (Typically from Schedule)
reportId xs:unsignedInt Required The identifier of the report
runBy xs:anyURI Required The URN of the user who initiated the report run
runId xs:unsignedInt Required The identifier of the run instance of report
status reportRunStatusType Required The current status of the report run
statusMessage xs:string Optional The current status/error message
timeCompleted xs:dateTime Optional The date/time the report run ended
timeRun xs:dateTime Optional The date/time the report run started
timeTaken xs:unsignedInt Optional The amount of time (in seconds) it took to run this report
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document