BatchType Object (IBatchType Interface)
This object corresponds to a batch type. Batch type is an attribute of a batch which defines how its documents should be processed. Several batch types for the most commonly used sets of processing settings can be defined in the project. All the batch types of the project are represented by the BatchTypes object.
The settings for processing batches of this type can be set using the BatchTypeParams object (use the Params property). However, note that not all settings are available via the API. Use FlexiCapture Developer's Package to set up batch types if you need to configure other settings, for example, the parameters of loading the images.
Please note that when you change the batch type settings via the BatchTypeParams object, all the existing batches with this type will be processed with the new settings.
Properties
Name | Type | Description |
---|---|---|
Name | String | Specifies the name of the batch type. |
Params | BatchTypeParams | Specifies the parameters of the batch type. |
Related objects
Output parameter
This object is the output parameter of the Item, AddNew methods of the BatchTypes object.
Input parameter
This object is the input parameter of the following methods:
- AddNewEx method of the Batches object.
- Delete method of the BatchTypes object.
Samples
This object is used in the following code samples: Classification.
See also
15.08.2023 13:19:30