The DocumentStoreIntegrityCheckTask is designed to allow SDK Developers to run integrity checks on a document store More...

Inheritance diagram for TRIM.SDK.DocumentStoreIntegrityCheckTask:

Public Member Functions
void	Dispose ()

	DocumentStoreIntegrityCheckTask (ElectronicStore store)

void	Run ()
	Runs the store integrity checker using the supplied parameters. The process is run asynchronously and you can monitor progress by examining the Status property and any of the processing counter properties. If you destroy this task before the run is complete then it will work in a similar way to as if you executed the Cancel function. More...

void	Cancel ()
	If you have started the asynchronous integrity check by calling the Run() function, then you can cancel it using this method. More...

long	GetProgressCounter (DocumentStoreIntegrityCheckCounter counter)
	Get the progress counter for the passed in DocumentStoreIntegrityCheckCounter enum. More...

Protected Attributes
bool	swigCMemOwn

Properties
ElectronicStore?	StoreBeingChecked `[get]`
	Gets the document store that is currently being checked ( the store pass into the task constructor) More...

string	BackupStorePath `[get, set]`
	Gets or sets a sstring value to specify a windows folder that contains a backup of the document store from some time in the past. When correcting a missing or corrupt file situation, the integrity checker will see if there is a better copy of this document within the backup store. Only works for Windows File System stores. More...

bool	DetailedCheck `[get, set]`
	Gets or sets a boolean value indicating whether to do a comprehensive detailed check or just a simple check for existence More...

bool	GenerateHash `[get, set]`
	Gets or sets a boolean value to tell the integrity checker to generate a hash for records that don't yet have a stored hash. Note this option is ignored unless you do a detailed check. More...

ElectronicStore?	StoreForCorrections `[get, set]`
	Gets or sets a ElectronicStore value that will be used if any new documents need to be added to the system as part of integrity check processing. By default, the store that is being checked will be used unless you specify an alternative. You need to specify an alternative if you provide a backup path and the store that is being checked is locked for further updates. More...

bool	FixErrors `[get, set]`
	Gets or sets a boolean value to indicate if the integrity checker should fix the store when errors are encountered. More...

bool	TreatPendingAsMissing `[get, set]`
	Gets or sets a boolean value to tell the integrity checker to treat any documents pending asynchronous transfer form the client to the workgroup as missing. More...

string	LogPath `[get, set]`
	Gets or sets a string value for the path for the log file generated by this run. More...

bool	OnlyLogErrors `[get, set]`
	Gets or sets a boolean value indicating whether to only log errors in the log file. By default, all activity will be logged. More...

int	BufferSize `[get, set]`
	Gets or sets a number value representing the buffer size used when processing a set of store references. Used when multi-threaded and also determines how often to save restart data More...

int	NumberOfThreads `[get, set]`
	Gets or sets a number value indicating how many threads should be used for processing. If you specify 0 then the task will run in single threaded mode. More...

int	ThreadTimeout `[get, set]`
	Gets or sets a number value indicating the timeout value (in seconds) being used for thread processing. A thread needs to complete a single operations within this time frame. More...

AsynchTaskStatus	Status `[get]`

string	ErrorMessage `[get]`
	Gets the current status of the asynchronous integrity check run. Gets the error message returned from processing if the status was Failed More...

Detailed Description

The DocumentStoreIntegrityCheckTask is designed to allow SDK Developers to run integrity checks on a document store

Constructor & Destructor Documentation

◆ DocumentStoreIntegrityCheckTask()

TRIM.SDK.DocumentStoreIntegrityCheckTask.DocumentStoreIntegrityCheckTask ( ElectronicStore store )

Member Function Documentation

◆ Cancel()

void TRIM.SDK.DocumentStoreIntegrityCheckTask.Cancel ( )

If you have started the asynchronous integrity check by calling the Run() function, then you can cancel it using this method.

◆ Dispose()

void TRIM.SDK.DocumentStoreIntegrityCheckTask.Dispose ( )

◆ GetProgressCounter()

long TRIM.SDK.DocumentStoreIntegrityCheckTask.GetProgressCounter ( DocumentStoreIntegrityCheckCounter counter )

Get the progress counter for the passed in DocumentStoreIntegrityCheckCounter enum.

◆ Run()

void TRIM.SDK.DocumentStoreIntegrityCheckTask.Run ( )

Runs the store integrity checker using the supplied parameters. The process is run asynchronously and you can monitor progress by examining the Status property and any of the processing counter properties. If you destroy this task before the run is complete then it will work in a similar way to as if you executed the Cancel function.

Member Data Documentation

◆ swigCMemOwn

bool TRIM.SDK.DocumentStoreIntegrityCheckTask.swigCMemOwn

protected

Property Documentation

◆ BackupStorePath

string TRIM.SDK.DocumentStoreIntegrityCheckTask.BackupStorePath

getset

Gets or sets a sstring value to specify a windows folder that contains a backup of the document store from some time in the past. When correcting a missing or corrupt file situation, the integrity checker will see if there is a better copy of this document within the backup store. Only works for Windows File System stores.

◆ BufferSize

int TRIM.SDK.DocumentStoreIntegrityCheckTask.BufferSize

getset

Gets or sets a number value representing the buffer size used when processing a set of store references. Used when multi-threaded and also determines how often to save restart data

◆ DetailedCheck

bool TRIM.SDK.DocumentStoreIntegrityCheckTask.DetailedCheck

getset

Gets or sets a boolean value indicating whether to do a comprehensive detailed check or just a simple check for existence

◆ ErrorMessage

string TRIM.SDK.DocumentStoreIntegrityCheckTask.ErrorMessage

get

Gets the current status of the asynchronous integrity check run. Gets the error message returned from processing if the status was Failed

◆ FixErrors

bool TRIM.SDK.DocumentStoreIntegrityCheckTask.FixErrors

getset

Gets or sets a boolean value to indicate if the integrity checker should fix the store when errors are encountered.

◆ GenerateHash

bool TRIM.SDK.DocumentStoreIntegrityCheckTask.GenerateHash

getset

Gets or sets a boolean value to tell the integrity checker to generate a hash for records that don't yet have a stored hash. Note this option is ignored unless you do a detailed check.

◆ LogPath

string TRIM.SDK.DocumentStoreIntegrityCheckTask.LogPath

getset

Gets or sets a string value for the path for the log file generated by this run.

◆ NumberOfThreads

int TRIM.SDK.DocumentStoreIntegrityCheckTask.NumberOfThreads

getset

Gets or sets a number value indicating how many threads should be used for processing. If you specify 0 then the task will run in single threaded mode.

◆ OnlyLogErrors

bool TRIM.SDK.DocumentStoreIntegrityCheckTask.OnlyLogErrors

getset

Gets or sets a boolean value indicating whether to only log errors in the log file. By default, all activity will be logged.

◆ Status

AsynchTaskStatus TRIM.SDK.DocumentStoreIntegrityCheckTask.Status

get

◆ StoreBeingChecked

ElectronicStore? TRIM.SDK.DocumentStoreIntegrityCheckTask.StoreBeingChecked

get

Gets the document store that is currently being checked ( the store pass into the task constructor)

◆ StoreForCorrections

ElectronicStore? TRIM.SDK.DocumentStoreIntegrityCheckTask.StoreForCorrections

getset

Gets or sets a ElectronicStore value that will be used if any new documents need to be added to the system as part of integrity check processing. By default, the store that is being checked will be used unless you specify an alternative. You need to specify an alternative if you provide a backup path and the store that is being checked is locked for further updates.

◆ ThreadTimeout

int TRIM.SDK.DocumentStoreIntegrityCheckTask.ThreadTimeout

getset

Gets or sets a number value indicating the timeout value (in seconds) being used for thread processing. A thread needs to complete a single operations within this time frame.

◆ TreatPendingAsMissing

bool TRIM.SDK.DocumentStoreIntegrityCheckTask.TreatPendingAsMissing

getset

Gets or sets a boolean value to tell the integrity checker to treat any documents pending asynchronous transfer form the client to the workgroup as missing.

Public Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DocumentStoreIntegrityCheckTask()

Member Function Documentation

◆ Cancel()

◆ Dispose()

◆ GetProgressCounter()

◆ Run()

Member Data Documentation

◆ swigCMemOwn

Property Documentation

◆ BackupStorePath

◆ BufferSize

◆ DetailedCheck

◆ ErrorMessage

◆ FixErrors

◆ GenerateHash

◆ LogPath

◆ NumberOfThreads

◆ OnlyLogErrors

◆ Status

◆ StoreBeingChecked

◆ StoreForCorrections

◆ ThreadTimeout

◆ TreatPendingAsMissing