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

  • Article
  • 2 minutes to read

Description

The information of the tasks.

Properties

Name Type Occurrence Description
application xs:string Optional application that this task belongs to
appointment xs:boolean Required DEPRECATED: Set to ‘true’ if this is an appointment.
appointmentId xs:string Optional DEPRECATED: If ‘appointment’ is ‘true’ this will contain the appointment ID.
assignedTo xs:anyURI Required The user, group or role this task is assigned to.
assignedToGroup xs:anyURI Optional The group this task is assigned to.
category xs:string Optional The category of task.
completedOn xs:dateTime Optional The date/time this task was completed.
completionDetails xs:string Optional Notes related to the task completion.
createdOn xs:dateTime Required The date/time that the task was created on.
details xs:string Optional A more detailed description with additional information that may be needed to assist with the completion of the tasks.
dueDate xs:dateTime Optional The date/time that the task is expected to be completed by. If not specified then there is no due date defined.
expires xs:dateTime Optional If an expiry date/time is specified here, when the time is reached and the task is still outstanding, the task will be completed with no outcome and set to a state of ‘expired’.
extra xs:string Optional A JSON structure representing additional content for the task
objectRefUrn xs:anyURI Optional Reference to an object specified by its URN
outcome taskOutcomeNameType Optional The outcome of the task.
outcomes xs:string Required A comma separated list of possible outcome values for this task.
owner xs:string Required The task owner id.
priority taskPriorityType Optional
Default=normal		 Identifies the priority of the task. If not specified, a default value of ‘normal’ is used.
progress percentageValueType Optional In the case where a task will take some time to complete, this can be used to indicate the progress of the work being done. A value between 0-100 is valid.
reference xs:string Optional Reserved for SYSTEM. The system defined references are workspaceJoin, bpmTask and bpmApproval
remindAssignee xs:boolean Optional Should assignee be sent reminder notifications about task’s due for completion date.
reminder xs:duration Optional Duration before task’s due for completion date, when reminder notifications should be sent out. If not specified, default value will be picked from system settings “task.notification.taskDueReminder”.
remindOwner xs:boolean Optional Should owner be sent reminder notifications about task’s due for completion date…
startDate xs:dateTime Optional The date/time that work is expected to commence. If not specified then there is no start date defined.
status taskStateType Required The current status of the task.
taskId xs:string Required The unique task identifier.
timeBillable xs:boolean Optional If set true, indicates that the time spent on this task is billable time.
timeSpent xs:unsignedInt Optional The amount of time spent on this task.
title xs:string Required The short description of the task to be actioned.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document