ServerTools (Component)

The methods within the ServerTools object either perform server-level actions or return server-level information. For example, tools lets you change license keys, check the Full-Text Search configuration, update a migrated site, validate the database scheme, and so on.

Methods marked below with [L] may be logged at the server level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

addHeartbeatJob [L]
buildStaleCache [L]	Rebuilds all stale cache that has been recently requested for all sites on this server. Note this should not be run from a Cache Server. Instead run SiteTools.buildStaleCache from a Cache Server for individual sites.
changeLicenseKeys [L]	Starts a job that makes changes to the CommonSpot installation to reflect the swap to new customer or server keys.
checkFullTextEngineConfiguration	Starts a background job to check the health of the default Full-Text Search engine.
checkReplication	Checks to see if replication is needed for any site that is configured to replicate in real time or on a schedule.
checkVerityInstallation	DEPRECATED - use checkFullTextEngineConfiguration instead.
clearStaleCacheForServer [L]	Removes the items from the queue for the specified server.
clearStaleCacheForSite [L]	Removes the items from the queue for the specified site.
confirmJavaAndJVMSettings [L]	Starts a job that insures that the correct configurations for Java and the Java Virtual Machine exist.
diagnoseDatabase [L]	Validates compatibility of database and datasource connection with CommonSpot and returns any error encountered.
getCategories	Returns a comma-delimited list of server tool categories.
getCurrentServerTimestamp	Returns the server's current date and time. The time stamp's format is 'yyyy-mm-dd hh:mm:dd'.
getList	Returns one or more structures, each containing information about a CommonSpot tool. The structure's members containing information on the tool's name, description, URL, and category. If the argument to this command is an empty string, CommonSpot returns information for all tools.
getSiteInfoFromDatasource	Returns a structure containing the site's root directory, the site's relative URL on the server, and the site's ColdFusion mapping.
getStaleCacheQueueItems	Returns a list of page within the specified site which are queued to have their cache rebuilt.
getStaleCacheServerQueueCounts	Returns the status of stale cache rebuild queue on different CommonSpot servers.
getStaleCacheSiteQueueCounts	Returns the status of stale cache rebuild queue on different CommonSpot sites.
heartBeat [L]	Forces processing of remote requests for this server.
importHelpData [L]	Imports CommonSpot help information. This information should already be installed. If it is not, this installs it. This tool will also update an existing help system.
updateMigratedSite [L]	Starts a job that fixes the site's URLs and updates the site ID in the application.cfm file for the specified site's data source. The method also writes messages describing it's actions.
validateDatabaseSchema	Starts a job that validates the database schema for the existing 'Sites' database.