INDEX

Documentation Library

Search for information on Hornbill Documentation.

Filter

Books

All
{{book.title}}
{{book.foundCount}}

Products

{{product.name}} {{docApp.searchFilteredProducts[product.id].returnedCount}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

{{resultItem.title}}

{{resultItem.url}}

{{resultItem.content}}

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

{{book.title}}

{{book.title}}

More...

Custom Cleanup

Operation Information

This operation will create a cleanup profile in the target machines registry, and use that profile when executing the Windows Disk Cleanup tool.

Note

The Reference input parameter should contain an integer value from 0 to 65535. NOTE: If there is a desk cleanup profile that already exists in the registry with the same reference as you choose, then this will be overwritten by what is selected in this job.

Input Parameters

Name	Type	Description	Required	Sensitive
`Reference`	`string`	The Reference number for the new disk cleanup profile in the Windows Registry.	Yes	No
`ActiveSetupTempFolders`	`boolean`	Active Setup Temp Folders	Yes	No
`BranchCache`	`boolean`	Branch Cache	Yes	No
`DownloadedProgramFiles`	`boolean`	Downloaded Program Files	Yes	No
`InternetCacheFiles`	`boolean`	Internet Cache Files	Yes	No
`OldChkDskFiles`	`boolean`	Old Chk Dsk Files	Yes	No
`PreviousInstallations`	`boolean`	Previous Installations	Yes	No
`RecycleBin`	`boolean`	Recycle Bin	Yes	No
`ServicePackCleanup`	`boolean`	Service Pack Cleanup	Yes	No
`SetupLogFiles`	`boolean`	Setup Log Files	Yes	No
`SystemErrorMemoryDumpFiles`	`boolean`	System Error Memory Dump Files	Yes	No
`SystemErrorMiniDumpFiles`	`boolean`	System Error Mini Dump Files	Yes	No
`TemporaryFiles`	`boolean`	Temporary Files	Yes	No
`TemporarySetupFiles`	`boolean`	Temporary Setup Files	Yes	No
`ThumbnailCache`	`boolean`	Thumbnail Cache	Yes	No
`UpdateCleanup`	`boolean`	Update Cleanup	Yes	No
`UpgradeDiscardedFiles`	`boolean`	Upgrade Discarded Files	Yes	No
`UserFileVersions`	`boolean`	User File Versions	Yes	No
`WindowsDefender`	`boolean`	Windows Defender	Yes	No
`WindowsErrorReportingArchiveFiles`	`boolean`	Windows Error Reporting Archive Files	Yes	No
`WindowsErrorReportingQueueFiles`	`boolean`	Windows Error Reporting Queue Files	Yes	No
`WindowsErrorReportingSystemArchiveFiles`	`boolean`	Windows Error Reporting System Archive Files	Yes	No
`WindowsErrorReportingSystemQueueFiles`	`boolean`	Windows Error Reporting System Queue Files	Yes	No
`WindowsErrorReportingTempFiles`	`boolean`	Windows Error Reporting Temp Files	Yes	No
`WindowsESDInstallationFiles`	`boolean`	Windows E S D Installation Files	Yes	No
`WindowsUpgradeLogFiles`	`boolean`	Windows Upgrade Log Files	Yes	No

Output Parameters

Name	Type	Description	Required	Sensitive
`errors`	`number`	The number of errors returned. See the job output for the error details	No	No

In This Document

{{docApp.title}}

{{docApp.description}}