CIFF extract task

The CIFF extract task automates the generation of CIFF formatted files that contain images that are extracted from the FTM database. It extracts the images by entry from the database. The entry number, category ID, and business date are used to identify each entry. A single CIFF extract file is generated for each entry that contains all the images that are present in the FTM database for the entry.

Important: Do not use this task to implement new CIFF extracts. The set of image archive Services Framework tasks has a task that replaces this CIFF extract task. For more information, see Image archive Services Framework tasks.

The CIFF extract task is configured to run in Services Framework. It can be started automatically or manually. The Transaction Server requests the automatic execution of a CIFF extract task when certain events occur based on user-defined schedulers. You can also use the Services Framework user interface to run the CIFF extract task for an entry.

When complete, the CIFF extract task requests entry events to be set to archived for all of its batches in the Transaction Server. The Transaction Server can be customized to start other events after the archived event is set.

CIFF extract files, with their routing and signal files, are created in a directory that you can specify in the configuration parameters. The CIFF extract file names are managed by using transmission definitions. The names of the CIFF extract file, routing file, and end output file can include their corresponding entry number, business date, and business category for tracking. To make sure that the file name is unique, include the creation date and time as part of the file name. A suggested file naming pattern is shown in the following example.

Cpp.Sss.Eeeee.BDyyyyMMdd.BCb.CDyyyyMMdd.CThhmmss

The parts of the pattern are described in the following list.

C

A static file name pattern tag that is used to indicate the primary environment. It has the following extract-specific information.

pp: The primary environment ID.

S

A static file name pattern tag that is used to indicate the secondary environment. It has the following extract-specific information.

ss: The secondary environment ID.

E

A static file name pattern tag that is used to indicate the entry. It has the following extract-specific information.

eeee: The entry number.

BD

A static file name pattern tag that is used to indicate the business date. The date has the following format.

yyyyMMdd: The file creation date with a four-digit year (yyyy), two-digit month (MM), and two-digit day (dd).

BC

A static file name pattern tag that is used to indicate the business category. It has the following extract-specific information.

b: The business category.

CD

A static file name pattern tag that is used to indicate the file creation date. The date has the following format.

yyyyMMdd: The file creation date with a four-digit year (yyyy), two-digit month (MM), and two-digit day (dd).

CT

A static file name pattern tag that is used to indicate the file creation time. The time has the following format.

hhmmss: The file creation time with a two-digit hour (hh), two-digit minute (mm), and two-digit second (ss).

Some of the parameters on the task configuration page for this task can be used to filter the images to include in the CIFF extract. The CIFF extract task also has a user exit routine that can be used to do more data filtering.