Cleanup

Design Log Cleanup

This task does not have any parameters, but uses the DesignerLogCleanupPeriod setting in System Configuration. This is set by default to 180 days, so Design log entries older than 180 days will be deleted.

Figure 1 - The Design Log Cleanup overlay

Design log entries for deleted projects will not be removed with the DB cleanup task, but wait for the Design Log cleanup to do its work.

DocumentStore Cleanup Task

The DocumentStore cleanup task will delete all document versions that are marked as expired. Version expiration is set based on the system configuration setting "MaxSurveyVersions". The latest x (MaxSurveyVersions) will be kept; the rest will be marked as expired (and thus cleaned whenever the DocumentStore cleanup task runs).

Figure 1 - The DocumentStore Cleanup overlay

• Batch size - defines how many versions will be deleted every time the task runs. So if you have 50 000 expired versions and the batch size is 1000, the cleanup task will delete 1000 versions and then stop.
• Verbose - check to get details of individual records that have been deleted. For example:

If Verbose is not activated -

• 1000 records deleted
• 2000 records deleted
• 3000...

If Verbose is activated -

• p1347856284 v13 has been deleted
• p1237495869 v7 has been deleted
• etc.

Note that Verbose is useful for trouble-shooting, but can quickly lead to very large task logs.

• Resource collection names - defines what will be deleted. I.e. Survey layouts and/or projects.
• Start Time - defines when the task is to run. Select Schedule for later execution to set up a recurring task.

NodeStore Cleanup Task

The NodeStorecleanup task will remove all data for the configured “resource collection names”, that is older than the “expiry days” setting configured in the NodeStore cleanup task definition.

Note: All documents exist in the DocumentStore. No data is lost when this cleanup job executes.

Figure 1 - The NodeStore Cleanup overlay

• Expiry days - defines the number of days NodeStore entries are to be kept (days to hold). Once the task is set to recurring, any changes to a property will be included for the next task run. The recommended expiry days setting for this task is 8 days.
• Resource collection names - defines what will be deleted. Ie. Survey layouts and/or projects.
• Start Time - defines when the task is to run. Select Schedule for later execution to set up a recurring task.

The following properties are located in System Configuration. Under "Searching":

• NodeStorageIndexingEnabled - If the indexing of changes in the node store is enabled - this is related to the index used by the Forsta Searching service (not related to the NodeStore cleanup task).

And under "Miscellaneous":

• NodeStoreExpiry - This is the number of days before versions will expire from NodeStore. Note that the versions will still be available and compressed in DocumentStore after being removed from NodeStore.

Searching and Indexing History Cleanup

Figure 1 - The Searching and Indexing History Cleanup overlay

The ...history cleanup task removes old entries in the ConfirmitSearch database. The Days to expire... value specifies the number of days the history is to be kept for each task before it is deleted.

The task parameters specify how long internal activity tracking data is kept. This data is really used for extended troubleshooting, so unless you are in the process of troubleshooting something related to the Forsta Searching service, the default values can be used when scheduling this task.

Hub Cleaning

Hub Cleanup can be performed periodically to permanently remove deleted hubs, sources and related objects from SmartHub. When a hub is deleted from the user interface, it will initially be “soft-deleted” (marked for deletion). The database will not be removed until the hub cleanup task runs after a specified number of days have passed.

There are two configuration settings in “System Configuration” for this:

• DaysToKeepHubDatabaseObjectsAfterSoftDeletion controls the number of days that must expire before the database holding data in the hub column store can be dropped. Note that as the definition of the hub is not deleted it will be possible to restore a deleted hub after the database is deleted. The hub loader will be able to recreate the database in the hub column store from the original sources (unless they have been removed).
• The definition of the hub will be deleted when more than the number of days specified in the DaysToKeepHubDesignObjectsAfterSoftDeletion config setting has passed. This can be set higher than the DaysToKeepHubDatabaseObjectsAfterSoftDeletion, since the definition is small compared to the actual data.

Single Page Survey Cleanup

This task cleans up any files created by the single page survey generation task where the files are older than 1 month.