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

  • Article
  • 2 minutes to read

Description

Settings to define the devliery of the Report output

Properties

Name Type Occurrence Description
application appNameType Optional The application to associate this scheduled job with.
dayMask scheduleDayMaskType Optional The scheduled job day of the week mask.
description xs:string Required The scheduled job description.
expireCount xs:integer Optional The number of times to run the schedule job.
jobId xs:int Optional The Id of the Scheduled Job Associated with the Report if not specified a job will be created
jobInfo xs:string Required The information needed to run the job. In the case of an xmlmc_api type, this would be the XML used to make the methodcall. The XML string can contain replace macros for {{identifier}}, the identifier can be any one of the following: - - {{nowDateTime}} - The current (UTC) date/time in ISO8601 YYYY-MM-DD HH:MM:SS format. - {{jobId}} - The identifier of the scheduled job
jobRunType scheduledJobRunType Required The type of job to run on the scheduled event.
mode scheduleType Required The job mode. Permissible values are runOnce, runDaily, runMonthly, runEveryPeriod.
monthMask scheduleMonthMaskType Optional The scheduled job month mask.
nextEvent xs:dateTime Optional The next scheduled event.
period xs:unsignedInt Optional The scheduled job period.
reference xs:anyURI Optional A reference used to identify scheduled job. For example, for report scheduling it could be (urn:sys:reporting:reportId)
runStatus scheduleRunStatusType Optional The job run status. Permissible values are disabled, running and expired
tag xs:anyURI Optional A tag used to identify groups of scheduled jobs. For example, for report scheduling it could be (urn:xmlmc:reporting:reportRun)
timeZone xs:string Optional Specify the timezone that you would like this schedule to use. If you do not specify any timezone, or set this empty, then UTC/GMT timezone is assumed.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document