EditAFP command

EditAFP hides areas, creates bar codes, and masks text in a production AFP file and writes the output to another file. The bar codes, hidden areas, and text masks must be defined in an AFP Visual Environment control file. This command is available only if AFP Editor is installed.

Format

EditAFP -c controlfile [-cp codepage] [-fontMapDir fontmapdirectory]
-i inputfile [-log] -o outputfile [-resDir resourcedirectories]
[-snf serialfile[:barcodedefinition] [-threads nn][-tracetracefile]
[-trclvl level][-ue userexit] [-version]
Note: Brackets indicate that the option is not required. Do not type any brackets when you enter the command.

Options

-ccontrolfile
The full path name of the AFP Visual Environment control file that contains the page group and index tag definitions. This option is required.
-cpcodepage
The default code page. This option is not required.

Values for codepage are:

IBM500
An EBCDIC code page (default).
IBM850
An ASCII code page.

-fontMapDirfontmapdirectory
The full path name of the directory that contains customized font-mapping files, which override the default font-mapping files. This option is not required. If it is not specified, only the default font-mapping files are used.
-iinputfile
The full path name of the input AFP file that you want to process. The input file must contain MO:DCA-P data with no line data. This option is required.

To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with //. When you specify a fully qualified name, two sets of quotation marks are required. For example, "//'USERID.PDS(MYDOC)'" or "//'USERID.SEQDS'". When you specify a partially qualified name, you only need one set of quotation marks. For example, "//PDS(MYDOC)" or "//SEQDS".

-log
EditAFP writes messages to the edit.log file in the directory where the EditAFP.jar file is located. If the file exists, EditAFP appends messages to it. This option is not required. If it is not specified, EditAFP writes messages only to the terminal.
-ooutputfile
The full path name of the file where the output AFP file is written. Any existing data in the file is overwritten. This option is required.

To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with //. When you specify a fully qualified name, two sets of quotation marks are required. For example, "//'USERID.PDS(MYDOC)'" or "//'USERID.SEQDS'". When you specify a partially qualified name, you only need one set of quotation marks. For example, "//PDS(MYDOC)" or "//SEQDS".

-resDirresourcedirectory;...
The full path names of one or more AFP resource directories that contain AFP resources. EditAFP looks for AFP resources in these resource directories before the resource directories identified to AFP Visual Environment when the control file was created. This option is not required.

Specify this option if AFP resources are not inline and are not in the same directories that you identified to AFP Visual Environment when the control file was created.

Separate multiple directories with a semicolon. If a resource directory path name contains a blank, enclose the path name in double quotation marks.

-snfserialfile[:barcodedefinition];...
The name of the Intelligent Mail bar code (IMB) serial number file and the name of the bar code definition in the control file that the serial number file applies to. This option is not required. If it is not specified, EditAFP uses the serial number file that was specified in the bar code definition when the control file was created. If you specify more than one serial number file and bar code definition name, separate them with a semicolon as shown in Examples.
serialfile
The full path name of the serial number file.
barcodedefinition
The name of the bar code definition. This name is optional. If no bar code definition name is specified, the serial number file is used for all IMBs in the AFP file. If the bar code definition name contains blanks or other special characters, enclose the name in double quotation marks.

Examples:

AIX or Linux:
-snf /directory/serialfile
-snf /directory/tofile:"to IMB"
-snf /directory/tofile:"to IMB";/directory/replyfile:"reply IMB"Windows:
-snf C:\directory\serialfile
-snf C:\directory\tofile:"to IMB"
-snf C:\directory\tofile:"to IMB";\directory\replyfile:"reply IMB"

-threadsnn
The number of threads that EditAFP starts. This option is not required. The default is five threads.
Note: If the control file contains bar code definitions for IMBs that use a serial number file and you want the serial numbers in the IMBs to be in sequential order by page group (for example, the serial number in the first page group is 000001, the serial number in the second page group is 000002, and so on) specify one thread. If you specify more than one thread, the serial numbers might not be in sequential order by page group. No matter how many threads you specify, the serial number in each IMB is unique.

Example:-threads 1

-tracetracefile
The full path name of the file where EditAFP writes trace information. If the file already exists, EditAFP appends to it. Otherwise, EditAFP creates the file. Use this option for diagnostic purposes only. This option is not required.
-trclvllevel
The level of tracing. This option is not required.

Values for level are:

debug
Trace at a higher level.
normal
Trace at a lower level (default).

-ueuserexit
The user exit class name. This option is not required.
-version
Displays the version number of EditAFP. This option is not required.

Examples–EditAFP

AIX: This example creates the hidden areas and bar codes defined in the infile.ctl control file and writes the output to the outfile.afp file: 
java -jar /install_directory/plugins/EditAFP/EditAFP.jar 
-i /directory/infile.afp -o /directory/outfile.afp 
-c /directory/infile.ctl

Windows: This example creates the hidden areas and bar codes defined in the infile.ctl control file and writes the output to the outfile.afp file: 

java -jar \install_directory\plugins\EditAFP\EditAFP.jar 
-i \directory\infile.afp -o \directory\outfile.afp 
-c \directory\infile.ctl

z/OS: This example creates the hidden areas and bar codes defined in the infile.ctl control file and writes the output to the outfile.afp file. Enter this command on the z/OS UNIX command line: 

java -jar /install_directory/plugins/EditAFP/EditAFP.jar 
-i /directory/infile.afp -o /directory/outfile.afp 
-c /directory/infile.ctl

z/OS system: This example creates the hidden areas and bar codes defined in control file directory/infile.ctl and writes the output to MVS data set USERID.OUTPUT.AFP(OUTFILE). (The output MVS data set must be cataloged.) On the z/OS UNIX command line, enter: 
java -jar /directory/plugins/EditAFP/EditAFP.jar 
-i //'USERID.INPUT.AFP(INFILE) -o //'USERID.OUTPUT.AFP(OUTFILE) 
-c /directory/infile.ctl;

z/OS system: This example creates the hidden areas and IMBs defined in control file /directory/infile.ctl and writes the output to MVS data set USERID.OUTPUT.AFP(OUTFILE). (The output MVS data set must be cataloged.) The IMB serial number files are /directory/toserial and /directory/replyserial. On the z/OS UNIX command line, enter: 
java -jar /directory/plugins/EditAFP/EditAFP.jar 
-i //'USERID.INPUT.AFP(INFILE)  -o //'USERID.OUTPUT.AFP(OUTFILE) 
-c /directory/infile.ctl -rd /directory/plugins/EditAFP
-snf /directory/toserial:"to IMB";/directory/replyserial:"reply IMB";

For install_directory, use the directory where you installed AFP Visual Environment.

For directory, use the directory where the file is located.

Exit codes

0
EditAFP was successful.
<0
EditAFP was not successful. No output file was created, or the output file is incomplete. EditAFP writes error messages to stderr and in the log file.
Parent topic: AFP Visual Environment commands