SiteTools (Component)

 

Methods:

backgroundBuildCacheFiles	Rebuilds cache for this site in the background, building cache for browsers selected in subsite properties.
backgroundRebuildCacheForSavedSearchResults	Rebuilds cache for the pages found by a saved search.
backgroundRebuildExpiringCache	Rebuilds cache in the background for pages with content expiring within the specified number of hours.
backgroundTest	Runs (sleeps) for the specified time and writes a log entry. Useful for testing background job scheduling.
buildAlternateImageFormats	Starts a job which builds the alternate image formats for the specified images with in the image gallery.
buildCacheFiles	Starts a job that builds cache files for this site. It will build a cache for each browser named in the 'browserList' argument.
cleanHTMLInTextBlocks	Starts a job that uses tidy to clean all text blocks. Tidy uses the HTML version when it makes changes.The same tidy settings are used for all page settings on the site.
convertField	Starts a job that converts to custom field type from source type to target type. Also handles any data conversions / fixes.
convertToReplicationTarget	Starts a job that converts the site to a replication target. A site using this name must also exist on a replication authoring server.
deleteErrorLogFiles	Deletes the CommonSpot error log for one or more specified dates.
fixSpacesInFileNames	Starts a job that fixes the file names of files and images whose names contain spaces.
getCategories	Returns a comma-delimited list of site tool categories.
getErrorLogFiles	Returns a query detailing the 50 most recent CommonSpot Error log files for the current site.
getFormsWithInconsistentData	Returns a query describing the forms who's data needs repair. Prior to 6.1 data may have had inconsistent dates and missing records when for fields added after data was initially entered.
getList	Returns a structure containing information about a CommonSpot tool. If the 'name' argument is set to an empty string, CommonSpot returns information for all tools.
rebuildCacheForSavedSearchResults	Starts a job that rebuilds cache for the pages found by a saved search.
rebuildLinkReferenceData	Starts a job that rebuilds the system data that contains an inventory of all link references.
rebuildStubFiles	Starts a job which rebuilds all stub files for the current site.
repairFormsWithInconsistentData	Repairs the data for the specified form.
repairLinksInRTE	Starts a job that repairs malformed link targets in formatted text blocks.
rescanImageSizes	Starts a job that rescans image sizes for images in the image gallery.
rescanLocalMultimediaFileSizes	Updates multimedia database records with actual file sizes on disk.
resetUploadedDocumentAccess	Starts a job that removes private uploaded documents and old versions of public uploaded documents from subsite's 'upload' folder.
sendBrokenLinkNotifications	Sends notifications for broken links.
sendContentFreshnessReminders	Sends freshness reminder notifications for pages that need checking based on the page's freshness reminder setting.
synchronizePageLanguage	Starts a job that synchronizes pages where the page's language does not match that of its subsite.
updateLinksForNewRootURL	Starts a job that update all URLs contained in rich text blocks . This insures that URLs are consistent with the site's base URL.
validateDatabaseSchema	Starts a job that validates the database schema for the existing 'Sites' database.
validateObject	Returns either an empty string or an error message indicating why an object does not meets the validation requirements set in the 'validationType' argument. If the 'errorMessage' argument is not an empty string and the object fails validation, an error is thrown using this specified message.