Reference › Test Case Reference › Filter Descriptions › Copybook Filters › Copybook Filter

Copybook Filter

The Copybook Filter converts copybook payloads to XML at run time. You can review and maintain your data by displaying these payloads in XML.

To open its editor, click the filter.

Complete the following fields:

Filter in

Specifies the name of the property to filter for the step. If the property is not in the pull-down menu, you can enter it. The property must exist. You can edit this value for this filter.

Copybook definition file

Designates the location where you store your copybook file definition.

Encoding

Select a valid Java charset. This value is used to try to convert the bytes in the payload into text for use in the output XML.

Default: UTF-8

Copybook parser column start

Copybooks frequently start each line with a line number. This parameter defines the column on which the parser starts when trying to parse a copybook file definition.

Value: A zero-based inclusive index. However, you can think of it as a "normal" one-based exclusive index.

Default: 6

Example: If you set this value to 6, the parser skips the first six characters in a line and starts with the seventh character.

Copybook parser column end

Occasionally, copybooks contain other reference data at the end of each line. When that happens, the parser must know on which column to stop. If there is no "extra" data at the end of the lines in the file, set this number to something greater than the length of the longest line in the file. If this number is greater than the length of a line, the parser stops at the end of the line.

Value: A zero-based exclusive index. However, you can think of it as a "normal" one-based inclusive index.

Example: If you set this value to 72, the parser reads the 72nd character in the line and then it stops.

Filter Run Results

Displays the property and values that result from running the filter.

Run Filter

To run and execute the filter, click Run Filter. The results appear in the Filter Run Results section.

For performance purposes, the Copybook filter caches the copybook definition in memory for 86400 seconds. When the time expires, DevTest removes the converted copybook definition from the cache. If the file is needed again, DevTest reads and reconverts it.