The DocumentStoreIncrementalCheckTask class is designed to be run periodically against new additions to the document store. It is a report-only tool and flags any errors that may have occurred recently in the store. If errors are detected, you can run the DocumentStoreIntegrityCheckTask to correct them. More...

Inheritance diagram for TRIM.SDK.DocumentStoreIncrementalCheckTask:

Public Member Functions
void	Dispose ()

	DocumentStoreIncrementalCheckTask (ElectronicStore store)

void	SetDateModifiedRange (SearchTimePeriodPlural timePeriod, int quantity)
	Allows you to set the range of modified dates for the objects to be incrementally checked More...

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 More...

bool	TreatPendingAsMissing `[get, set]`
	This property allows you to tell the incremental checker to treat any documents pending asynchronous transfer from the client to the workgroup as missing. More...

string	LogPath `[get, set]`
	This property allows you to set the path for the log file generated by this run. More...

bool	OnlyLogErrors `[get, set]`
	This property allows you to set whether to only log errors in the log file. By default, all activity will be logged. More...

int	QuantityOfTimePeriods `[get]`
	Gets the number of time periods to use to formulate the dateModified range More...

SearchTimePeriodPlural	TimePeriod `[get]`
	Gets the time period to use to formulate the dateModified range More...

bool	DoRecords `[get, set]`
	Gets or sets a boolean value indicating whether stored documents representing the current document of a record should be checked More...

bool	DoRevisions `[get, set]`
	Gets or sets a boolean value indicating whether stored documents representing a previous revision of a record should be checked More...

bool	DoRenditions `[get, set]`
	Gets or sets a boolean value indicating whether stored documents representing a rendition of a record should be checked 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...

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 DocumentStoreIncrementalCheckTask class is designed to be run periodically against new additions to the document store. It is a report-only tool and flags any errors that may have occurred recently in the store. If errors are detected, you can run the DocumentStoreIntegrityCheckTask to correct them.

Constructor & Destructor Documentation

◆ DocumentStoreIncrementalCheckTask()

TRIM.SDK.DocumentStoreIncrementalCheckTask.DocumentStoreIncrementalCheckTask ( ElectronicStore store )

Member Function Documentation

◆ Cancel()

void TRIM.SDK.DocumentStoreIncrementalCheckTask.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.DocumentStoreIncrementalCheckTask.Dispose ( )

◆ GetProgressCounter()

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

Get the progress counter for the passed in DocumentStoreIntegrityCheckCounter enum.

◆ Run()

void TRIM.SDK.DocumentStoreIncrementalCheckTask.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.

◆ SetDateModifiedRange()

void TRIM.SDK.DocumentStoreIncrementalCheckTask.SetDateModifiedRange	(	SearchTimePeriodPlural	timePeriod,
		int	quantity
	)

Allows you to set the range of modified dates for the objects to be incrementally checked

Member Data Documentation

◆ swigCMemOwn

bool TRIM.SDK.DocumentStoreIncrementalCheckTask.swigCMemOwn

protected

Property Documentation

◆ BufferSize

int TRIM.SDK.DocumentStoreIncrementalCheckTask.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.DocumentStoreIncrementalCheckTask.DetailedCheck

getset

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

◆ DoRecords

bool TRIM.SDK.DocumentStoreIncrementalCheckTask.DoRecords

getset

Gets or sets a boolean value indicating whether stored documents representing the current document of a record should be checked

◆ DoRenditions

bool TRIM.SDK.DocumentStoreIncrementalCheckTask.DoRenditions

getset

Gets or sets a boolean value indicating whether stored documents representing a rendition of a record should be checked

◆ DoRevisions

bool TRIM.SDK.DocumentStoreIncrementalCheckTask.DoRevisions

getset

Gets or sets a boolean value indicating whether stored documents representing a previous revision of a record should be checked

◆ ErrorMessage

string TRIM.SDK.DocumentStoreIncrementalCheckTask.ErrorMessage

get

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

◆ LogPath

string TRIM.SDK.DocumentStoreIncrementalCheckTask.LogPath

getset

This property allows you to set the path for the log file generated by this run.

◆ NumberOfThreads

int TRIM.SDK.DocumentStoreIncrementalCheckTask.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.DocumentStoreIncrementalCheckTask.OnlyLogErrors

getset

This property allows you to set whether to only log errors in the log file. By default, all activity will be logged.

◆ QuantityOfTimePeriods

int TRIM.SDK.DocumentStoreIncrementalCheckTask.QuantityOfTimePeriods

get

Gets the number of time periods to use to formulate the dateModified range

◆ Status

AsynchTaskStatus TRIM.SDK.DocumentStoreIncrementalCheckTask.Status

get

◆ StoreBeingChecked

ElectronicStore? TRIM.SDK.DocumentStoreIncrementalCheckTask.StoreBeingChecked

get

Gets the document store that is currently being checked

◆ ThreadTimeout

int TRIM.SDK.DocumentStoreIncrementalCheckTask.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.

◆ TimePeriod

SearchTimePeriodPlural TRIM.SDK.DocumentStoreIncrementalCheckTask.TimePeriod

get

Gets the time period to use to formulate the dateModified range

◆ TreatPendingAsMissing

bool TRIM.SDK.DocumentStoreIncrementalCheckTask.TreatPendingAsMissing

getset

This property allows you to tell the incremental checker to treat any documents pending asynchronous transfer from the client to the workgroup as missing.

Public Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DocumentStoreIncrementalCheckTask()

Member Function Documentation

◆ Cancel()

◆ Dispose()

◆ GetProgressCounter()

◆ Run()

◆ SetDateModifiedRange()

Member Data Documentation

◆ swigCMemOwn

Property Documentation

◆ BufferSize

◆ DetailedCheck

◆ DoRecords

◆ DoRenditions

◆ DoRevisions

◆ ErrorMessage

◆ LogPath

◆ NumberOfThreads

◆ OnlyLogErrors

◆ QuantityOfTimePeriods

◆ Status

◆ StoreBeingChecked

◆ ThreadTimeout

◆ TimePeriod

◆ TreatPendingAsMissing