X9Utilities ImagePull

X9Utilities ImagePull is designed to extract images from a series of x9 files driven by a user supplied pick list which identifies the specific items to be pulled. This function is designed to allow a large number of images to be pulled in a single run across a large number of x9 files. Items are identified using an input CSV file which is provided on the command line. Extracted images are written to an output image folder in the same byte format as they are present on the input x9 file. There is no attempt to either validate or transform the images. By default, front images will be written for each selected item. Back side images can be enabled using a command line switch.

Picklist

ImagePull reorganizes the pick list by x9 file and then dispatches the image extraction process to a series of background threads which are run in parallel. In support of optimization, each x9 file is only read once. The reading process for any single x9 file is terminated when all requests for that individual file have been satisfied. The picklist is a CSV and must be formatted as follows:

Column	Presence	Content	Example
1	Mandatory	Fully qualified x9 file name enclosed in quotes and always using forward slash as file separators.	“c:/user/folder/fileName”
2	Mandatory	Item sequence number for the item to be pulled as identified on the type 25 (check) or type 31 (return) item.	44000001
3	Optional	Item amount as a further qualifier for the item to be pulled (specified as numeric and without leading zeroes.	10000

Output CSV

An output CSV is created which identifies the images which have been extracted for each pull request. The output CSV includes the fully qualified file name for each image as well as various fields which are associated with the item group. The output CSV is written in the same sequence as the input picklist, regardless of how the items had to be internally reorganized for the pull process. The output CSV (by default) contains the following fields:

Column	Field Name	Content
1	x9fileName	X9 file name as echoed from the pull request.
2	itemSequenceNumber	Item sequence number as echoed from the pull request.
3	frontImage	Fully qualified name of the extracted front image file.
4	backImage	Fully qualified name of the extracted back image file.
5	recordType	Record type for the selected item group.
6	recordNumber	Record number of the selected item group within the x9 file.
7	auxOnUs	Auxiliary OnUs field from the item record.
8	epc	External processing code from the item record.
9	payorRouting	Payor routing from the item record.
10	payorRoutingCheckDigit	Payor routing check digit from the item record.
11	onus	OnUs from the item record.
12	amount	Amount from the item record.
13	bofdIndicator	BOFD indicator from the item record.
14	returnLocationRouting	Return location routing number from the bundle header record.
15	bofdDate	BOFD from the first BOFD addendum record.
16	bofdRouting	BOFD routing from the first BOFD addendum record.
17	imageCreatorRouting	Image creator date from the first type 50 record.
18	imageCreatorDate	Image creator date from the first type 50 record.
19	returnReason	Return reason from the type 31 return record.

Extracted Image File Names

ImagePull will format the file name for each extracted images into a standardized and fully qualified format that includes the complete file system path. In certain error situations, the image file name is replaced by a constant string to identify a specific error condition as follows:

• “file-not-found”: the x9 file associated with this picklist item was not found.
  “item-not-found”: the item was not found based on the provided criteria within the identified x9 file.
• “item-no-image”: the item was found but did not have an attached image.
• “file-aborted”: internal error occurred during the processing of the identified x9 file and the image is not available. More information on the error can be found in the created system log.

Error CSV

XML parameter file

Command Line Switch	Description
-config:	Use a specific x9 configuration for validation which defaults to “x9.37”. For example, the CPA 015 standard can be selected as: “-config:x9.CPA_015”.
-parms:	Specifies an optional xml parameter file which identifies the fields to be included in the output CSV and the order that those fields will be written. Fields are identified by name and must be selected from a list of system available field names. When omitted, ImagePull will include all available output fields in a predetermined order.
-cr	Include selection of images for record credit record type 61 and 62.
-ib	Pull and write back side images; the default is to omit back side images.
-ix	A time stamp (date and time) is appended to the output image folder name to make it unique for each image pull run.
-ic	The output image folder for this run will be cleared when it already exists. This process will only remove TIFF files since those are the only expected file extensions which would be expected to exist in the output image folder.
-ia	Override to forcibly not abort when the output image folder is not empty. If you do not set this override switch, ImagePull will abort if the output image folder exists and contains one or more files (regardless of extension). The default action is to abort. This abort situation can be avoided through use of either the “ix” switch to append a time stamp to the image folder name (making it unique) or the “if” switch to clear the output image folder when it is determined to exist.
-l	Will list all type 25 and type 31 x9 records to the system log.