CIFF Extract Configuration Parameters
Table 1 shows the configuration
parameters required by the CIFF extract task.
| Parameter | Required | Default | Description |
|---|---|---|---|
| Output directory | Yes | None | The directory where CIFF extract files are created. This can be the outgoing directory, where Gateway Server looks for files to process. The directory must exist in the system and be no more than 256 characters. |
| Work directory | Yes | None | The working directory used by the task for creating temporary files during the CIFF extract. |
| Transmission definition name | Yes | None | The transmission definition name used for locating the channel and naming pattern for CIFF extract output files. |
| Transaction Server host URL | Only if the images are remotely located | None | Host URL of the Transaction Server |
| Transaction Server RMI port number | Only if the images are remotely located | None | RMI port number of the Transaction Server |
| User exit routine name | No | None | Fully qualified name of the user exit routine class. It is only required when the user exit is used. For example, com.mybank.exists.MyBankUserExitRoutine. |
| Control document image extract | No | False | Whether the images corresponding to control documents must be extracted |
| Suspect image extraction | No | False | Whether the images corresponding to suspect items must be extracted |
| Latest version extraction | No | True | Determines if only the latest version of corrected items is extracted |
| Entry reextract | No | False | Indicates whether the images corresponding to an entry can be extracted again. The parameter does not apply to restart runs. |
| Completion state setting | No | True | Indicates whether the archived state must be set for all the batches in the entry when an CIFF extract completes. Disabling this option, eliminates the requirement of the Transaction Server being started and listening for CIFF extract task requests on the queue specified by the task's Transaction Server MQ name configuration parameter. |
| Front black and white image extraction | No | True | Indicates whether the front black and white images must be extracted |
| Front grayscale image extraction | No | True | Indicates whether the front grayscale images must be extracted |
| Back black and white image extraction | No | True | Indicates whether the back black and white images must be extracted |
| Back grayscale image extraction | No | True | Indicates whether the back grayscale images must be extracted |
| Codeline extraction | No | False | Indicates whether segment zero, which contains the codeline data, must be created |
| Fixed length codeline fields | No | False | Indicates whether the codeline fields must be of fixed length. The parameter only applies when the codeline extraction parameter is true. |
| Primary Environment Identification | No | None | Text to indicate the CIFF extract primary environment ID (site ID) |
| Secondary Environment Identification | No | None | Text to indicate the CIFF extract secondary environment ID |
| Error on image retrieval failures | No | True | The maximum number of acceptable image retrieval failures. If specified, an exception is issued when the threshold is exceeded. |
| Non imaged item extraction | No | True | Whether or not items with no images must be extracted |
| Large image extraction | No | None | The maximum number of bytes on extracted images. This is only required when images larger than a certain size must be bypassed. |
| Small file maximum size | No | 20000000 | The performance monitoring maximum number of bytes for an extract file to be considered of small size |
| Medium file maximum size | No | 2000000000 | The performance monitoring maximum number of bytes for an extract file to be considered of medium size |