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

Description

This type represents a file.

Properties

Name Type Occurrence Description
cafsAccessToken xs:string Optional The access token needed to access the file content from the CAFS.
contentId xs:string Optional This contains the CAFS contentId.
deletionDateTime xs:dateTime Optional Date and time of deletion (if deleted)
embeddedContentId xs:string Optional If this file is an embedded content item, such as an embedded image, then this is the ID that identifies the content within the MIME message encoding
fileDescription fileDescriptionType Optional The description of the file. Currently this is only supported for Entity File Attachments and File Sharing.
fileId xs:integer Optional The unique identifier of the file.
fileName fileNameType Required The name of the file as displayed to the user. (i.e. TheFile.txt).
fileSize xs:unsignedInt Optional The size of the file in bytes. This is not required for related write operations, but provides information when receiving file attachment information.
fileSource xs:string Required The fully qualified path to the file content. This can be any file accessible to the session or reports folder thru WebDAV service, or any other accessible web resource. For example ‘/session/myfile.doc’ or ‘http://www.hornbill.com/thefile.pdf’ or For example ‘/secure-content/inline/
folder xs:string Optional The containing folder (fully qualified folder path)
mimeType xs:string Optional The MIME type that identifies the content data. If not specified on write operations, the server will use the filename extension to establish the mime type
timeStamp xs:dateTime Optional The date/time the file was last modified.
In This Document