Sample control file templates for external programs

Ricoh ProcessDirector provides sample control file templates for use with external programs in the C:\aiw\aiw1\samples\external_programs\ directory.

The external program control file that Ricoh ProcessDirector generates from the control file template passes information between Ricoh ProcessDirector and the external program. Authorized users can copy and modify the sample control file templates that Ricoh ProcessDirector provides. They then put the customized control file template in any directory that is accessible to Ricoh ProcessDirector . Use the External control file template job property to specify the name and location of the control file template.

    Note:
  • Updates might overwrite files in the C:\aiw\aiw1\samples directory, but they do not overwrite files in the C:\aiw\aiw1\control_files directory. We recommend copying sample files into the C:\aiw\aiw1\control_files directory and making all your changes in the copied file.

Ricoh ProcessDirector supplies one control file template for external programs:

job_info.cfg
This control file is used by the sample PDF workflow. The control file has a list of symbols for nine job properties. When Ricoh ProcessDirector creates a control file from this template, it resolves the values for the ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime},${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages}, and ${Job.TotalSheets} symbols to the actual Ricoh ProcessDirector job properties.

The AFP Support feature supplies these additional control file templates for external programs:

prepare_line2afp.cfg
This control file template uses Ricoh ProcessDirector symbol formulas to set parameter values for the line2afp command. Ricoh ProcessDirector uses this command to convert line-data jobs into the AFP format. These are examples of the entries in the control file template:
DUPLEX=${Job.Duplex}
FILEFORMAT=${Job.Line2AFP.FILEFORMAT}
FORMDEF=${Job.Line2AFP.FORMDEF}
MCF2REF=${Job.Line2AFP.MCF2REF}
PAGEDEF=${Job.Line2AFP.PAGEDEF}

The keywords to the left of the equal sign are IBM AFP Conversion and Indexing Facility (ACIF) parameters. The values to the right are symbol formulas for Ricoh ProcessDirector job properties. Using FILEFORMAT=${Job.Line2AFP.FILEFORMAT} as an example, Ricoh ProcessDirector sets the value of the FILEFORMAT parameter that the line2afp command uses to the value of the Line data file format job property.

The control file template also uses the Ricoh ProcessDirector getFileName method to return the names of files that the data-conversion program needs to read and write in the spool directory for the job. The spool directory for a job is C:\aiw\aiw1\spool\default\JobNumber , where JobNumber is the actual spool ID that Ricoh ProcessDirector assigns to the job. Authorized users can also create additional spool directories. Additional spool directories have names that are in this format: C:\aiw\aiw1\spool\SpoolName \ JobNumber. These entries in the control file template use methods:

INPUTDD=${getFileName(print, (linedata, afp), read)}
Provides the name of the data file for the job to the data-conversion program. The method returns the name of the line data spool file (JobNumber.print.linedata), if it is present. If it is not present, the method returns the name of the AFP spool file (JobNumber.print.afp), if it is present. If neither is present, the method returns JobNumber.print.unknown. The data-conversion program reads this file and uses it as its initial input.
OUTPUTDD=${getFileName(print, afp, write)}
Provides the name of the converted file that the data-conversion program should write to the spool directory. The format of this file name is JobNumber.print.afp; this file contains the output from the data-conversion program.
RESOBJDD=${getFileName(resources, afp, write)}
Provides the name of the resource file that the data-conversion program should write to the spool directory. The format of this file name is JobNumber.resources.afp. This file contains optional output from the data-conversion program.
prepare_line2afp_ascii.cfg
This control file template does the same functions as the prepare_line2afp.cfg control file template with one exception. This control file template calls an input exit, apka2e, that converts the job from the ASCII format into the EBCDIC format. For detailed information about the INPEXIT parameter, see AFP Conversion and Indexing Facility User's Guide, G550-1342.
prepare_transform.cfg and prepare_transform_APPE.cfg
These control file templates pass information between Ricoh ProcessDirector and a Ricoh ProcessDirector Transform feature or InfoPrint Transform Manager. They use symbol formulas to set values of transform flags and method calls to read and write files in the spool directory. These are examples of the entries in the prepare_transform.cfg and prepare_transform_APPE.cfg control files:
# Input file to transform
-itm_in_files = ${getITMInputFileName()}
# Output file to create
-itm_out_files = ${getFileName(print, ${Job.Transform.Datastream}, write)}
# Page size
-w = ${truncate(3, ${Job.PageWidth})}i
-l = ${truncate(3, ${Job.PageLength})}i
# Halftone
-gcorr = ${get.HalftoneFileNameTf()}
-thresh = ${get.HalftoneFileNameTa()}

For detailed information about transform flags, see the Ricoh ProcessDirector Transform feature information center or InfoPrint Transform Manager for AIX, Linux and Windows: Planning and Installing, G550-20160.