Batch data

The following are available for batch data.

  • Batch Fields (mapped)

    If folders are enabled the batch fields can be mapped with folder fields of the root XFolder. Then the access is read/write during runtime and when updating the folder field of the root XFolder, the data are written to the mapped batch field on Kofax Capture side.

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

    All batch field values are accessible read-only from script. They are saved in the corresponding XValue of the root XFolder object.

    XRootFolder.XValues.ItemByName("AC_FIELD_"& BatchFieldName)
    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.
  • Batch Properties

    The following batch properties are accessible from script (XRootFolder.XValues.ItemByName (XValue key):

    Batch Property XValue key
    Batch Name (read-only) AC_BATCH_NAME
    Batch Class Name (read-only) AC_BATCH_CLASS_NAME
    Priority (read/write) AC_BATCH_PRIORITY
    ImageDirectory (read-only) AC_IMAGE_DIRECTORY
    ExternalBatchID (read-only) AC_EXTERNAL_BATCHID
    BatchGUID (read-only) AC_BATCH_GUID
    BatchCreationDateTime (read-only) AC_BATCH_CREATIONDATETIME
    CreationSiteName (read-only) AC_BATCH_CREATIONSITENAME
    CreationUserID (read-only) AC_BATCH_CREATIONUSERID
    OperatorUserID (user ID of last batch history entry) (read-only) AC_BATCH_OPERATORUSERID
    UserID (read-only) AC_BATCH_USERID
    UserName (read-only) AC_BATCH_USERNAME
    WindowsUserName (read-only) AC_BATCH_WINDOWSUSERNAME

Multiple steps of Validation

If for the validation the multiple steps are activated the information about the next validation step that is required for validating the batch can be found in the CustomStorageString TM.BatchNextValidationStep as a one-based number. This information can be used for example for workflow agents that route the batches and skip certain Validation steps