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

Scheduling Reports

As well as running reports manually, you can also schedule the reports to run and be distributed on definable intervals to documents in Document Manager.

Report Schedule Intervals

Reports can be scheduled on the following intervals:

  • Run Once
  • Run Daily - Choose to run on all or specific days at a set time
  • Run Monthly - Choose to run on all or specific months on a set day and time in each month
  • Run Every Period (Minutes)

Publishing

Email

  • Choose the output type
  • Specify the email recipient

Document Manager

Reports can be scheduled to be distributed to an existing document in Document Manager.

  • Find the document you want the report to be distributed to by searching for documents using their document tags.

Tip

If you don’t have a document you wish to distribute your report to, create a new document in Document Manager by:

  • Running a report manually and downloading it.
  • In Document Manager choose the Upload a new document option, then Upload the report file.
  • Give the document a title, and tick the allow versioning option (this will allow add a new revision of the document automatically each time the schedule of the report is run).
  • Add a document tag such as Reports which you can then use in the Document search bar under the * Publishing option to find and choose the document to distribute future scheduled iterations of the report too.
  • Choose the File Type in which the scheduled report will be created and distributed to the chosen document - ensure this matches the type of document you are looking to distribute this too. The available formats in the drop down will mirror the file types you have enabled under the Output Format tab.

Once the Report is Scheduled, it will show as Running

  • Pause the Schedule and prevent further distribution of the report by clicking on the pause icon
    • This will mark the report as disabled
    • Click the play icon to resume the report schedule

Audit

  • Click on the view log to see the history for the report schedule.
  • Click on the Report History tab and the i icon next to each run of the report to see more detail of when it ran, what report outputs were created and which document they were distributed too.

Viewing Distributed Reports

Document Manager Report Distribution.png When a report has been scheduled, generated and then distributed to a document it will become the current version of the document. The previous version will appear in the revisions section, as an early version of the report.

  • Each time a new version of the report is distributed to the document it will become the current version, and all previous versions will be accessible from the revisions section
  • The Report documents are then accessible to be viewed and collaborated on by any user the documents has been shared with either in the user app and or via the native mobile apps (iOS and Android)

Tip

Creating and adding the report documents to a reports library and then sharing the library with users, groups and roles will allow users easy access to all relevant reports and each distributed version / iteration of them

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document