Folder data

Folder fields and folders are only available when folders are enabled in the project settings. Having folders enabled, one Kofax Capture folder class is mapped to one folder definition on the Kofax Transformation Modules integration side. The folders are assigned to a fixed level in Kofax Transformation, this concept is inherited by the folder class at the Kofax Capture although the folder class does not have this limitation.

  • Folder Index Fields (mapped)

    All mapped folder fields have read/write access and by updating the folder field of the XFolder its data are written to the mapped Kofax Capture folder field. The initial values of the folder fields are read from the mapped Kofax Capture folder field.

    Note The "Populate all fields for read-only access" option is not required for mapped index fields.
  • Folder Index Field Values

    During runtime all folder field values of a folder are accessible read-only from script. They are saved in the corresponding XValue of the XFolder object.

    XFolder.XValues.ItemByName("AC_FIELD_" & FolderFieldName)
    Note If you cannot access the field values via script, then you need to check whether the "Populate all index fields for read-only access in script" option is selected on the Extended Synchronization Settings window of the Kofax Transformation - Synchronization Tool. This option is cleared by default.
  • Folder CSS

    Additionally, all CustomStorageStrings defined on the Kofax Capture side are transferred to the XValues collection of the XFolder object.

    XFolder.XValues.ItemByName("AC_CSS_" & CSSName)

    In order to write CustomStorageString values back to Kofax Capture, set the property MustSynchronize to TRUE so that changes in the XValues are transferred to the corresponding CustomStorageString. By using the naming convention and setting the MustSynchronize property you can also add new XValues to the collection of the XFolder so that new CustomStorageStrings on Kofax Capture side are created.