RootFolder

The CscScriptRootFolder RootFolder object and the corresponding script sheet are only available if folders are enabled. It provides events for foldering.

Foldering events occur during server processing and if allowed, during Validation.

The following image illustrates the script event sequence that occurs when foldering is executed:
An image that shows the Foldering event chronology.

The BeforeAutoFoldering and AfterAutoFoldering events are fired but they are not yet supported by a configuration interface.

Use the DoFoldering event to group the documents into subfolders. This event sequence is followed by the Folder Extraction and Validation Events that are used to calculate folder field data or in combination, with a folder field validation rule to control the contained documents in the folder. For more information about applying Foldering please refer to Foldering.

The DoFoldering event is fired once only. This means that if a batch or document is sent to Kofax Capture - Quality Control because of an error, the DoFoldering event is not fired again once the batch is resolved and sent for further processing.

You can skip the complete foldering process by setting the bSkip parameter of the BeforeAutoFoldering event to TRUE. If you want to skip Foldering for the validation step you can ensure that this event is initiated by server processing only, or by manually checking the Project.ScriptExecutionMode property.

Private Sub RootFolder_BeforeAutoFoldering(ByVal pXRootFolder As CASCADELib.CscXFolder, ByRef bSkip As Boolean)
   If Project.ScriptExecutionMode = CscScriptModeValidation Then
      bSkip = True
   End If
End Sub

RootFolder

Search results

Search tips