CIFF extract task file name pattern

The CIFF extract task creates the following file set in the output directory.

.ciff file: This file contains all the extracted records.
.rte file: This file contains the routing information.
.eof file: This file indicates that the file set is complete.

To name the files in the file set, the CIFF extract task uses a file naming pattern from the transmission definition configuration. Based on the number of the entry that was loaded and its category ID, the naming pattern uses a substitution algorithm to produce a unique file name for each CIFF extraction. All files in a single file set are created with the same file name, but their file extensions are different. Distinct file extensions are added to the file name to generate the complete notification file set. This file name substitution pattern is used to ensure that the names of the files that are sent to the Gateway outgoing directory are unique.

The file name must be configured by using the add transmission definition page. For more information about file naming patterns and configuring transmission definitions, see File name patterns and routing file formatters and Manage Transmission Definitions page.

The following table shows the file naming substitutions that the CIFF extract supports.

Table 1. CIFF extract file name substitutable values
Name	Optional value parsing examples	Substitution
`%PI%`		Primary environment ID
`%SI%`		Secondary environment ID
`%EN%`		Entry number
`%BD%`		Business date with the format `YYMMDD`.
`%BC%`		Business category
`%DT%`	`%DTyyMMdd%` and `%DThhmmss%`	File creation date and time

This example is a sample file name pattern:

C%PI%.S%SI%.E%EN%.BD%BD%.BC%BC%.CD%DTyyMMdd%.CT%DThhmmss%

This pattern creates a file name that includes the primary and secondary environment IDs, the entry number, the business date, the business category ID, and the file creation date and time. On a CIFF extract for entry 1234, business date 28 September 2009, and business category 1, occurring on 29 September 2009 at 1:41:20 PM, under primary environment ID 88 and secondary environment ID 99, the file name that this pattern creates is:

C88.S99.E1234.BD090928.CD090929.CT134120

The file name pattern does not include the file extension, so the CIFF extract adds file extensions to each file it creates. It delivers these files to the output directory:

C88.S99.E1234.BD090928.CD090929.CT134120.ciff
C88.S99.E1234.BD090928.CD090929.CT134120.rte
C88.S99.E1234.BD090928.CD090929.CT134120.eof

The .ciff file contains the extracted image in the CIFF file format. The .rte file contains routing information that Gateway uses to send the file to its destination. An empty .eof file is always written last to signal that the other files are delivered and are ready for processing.

For more information about the file extensions, see CIFF Extract File Format.

The parameters that are used for transmission definitions for the CIFF extract are shown in the following list.

Name
Channel
Test file indicator
File name pattern
Time zone

A formatter is a Java™ class that generates a custom routing file string. To create a custom routing file, the user must implement a unique formatter class and define the class and routing file schema name. Define the class and routing file schema name on the edit transmission definition page. For more information about defining the class and routing file schema name, see File name patterns and routing file formatters.