Sample control files for job audit information

RICOH ProcessDirector logs audit information when a step based on the WriteJobLog step template runs or when it deletes a job from the system. RICOH ProcessDirector deletes a job when its retention period expires or when it completes processing and has no retention period. It also deletes a job when it receives a specific request from an authorized user. The audit files for jobs are in the Comma Separated Value (CSV) format, and use RICOH ProcessDirector symbol notation to represent specific job properties.

Control files define the content of audit files.

  • The WriteJobLog step writes a single audit file based on the control file that the External control file template job property specifies to the directory that the External control file template job property specifies.
  • When it deletes a job, RICOH ProcessDirector writes an audit file based on each control file in the C:\aiw\aiw1\control_files\audit\ directory to the C:\aiw\aiw1\audit\Job directory.

Note: Always modify your own copies of control files, not the sample files. The sample files might be overwritten by service updates. The names of the copies determine the names of the files whose contents they define. For example, if you copy job_properties.cfg as my_job_properties.cfg, RICOH ProcessDirector creates both jobnumber.yy-mm-dd_hh-mm-ss.job_properties.cfg.csv and jobnumber.yy-mm-dd_hh-mm-ss.my_job_properties.cfg.csv when it deletes the job.

RICOH ProcessDirector installs control file templates for job-audit information in the C:\aiw\aiw1\samples\audit\ directory. To customize a control file, copy it into the C:\aiw\aiw1\control_files\audit\ directory and edit it.

    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 provides these control files for job-audit information:

job_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.job_properties.cfg.csv audit file in the C:\aiw\aiw1\audit\Job directory. The control file causes RICOH ProcessDirector to record basic information about the job, such as the name and size of the input file and the total numbers of pages and sheets that the job contains.
job_info_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.job_info_properties.cfg.csv audit file. RICOH ProcessDirector records values of certain JCL parameters, such as ADDRESS and BUILDING. For jobs that were submitted through a hot folder, RICOH ProcessDirector records only the job number for the job in the audit file. If the AFP Support feature is installed, the control file causes RICOH ProcessDirector to record information that is specific to jobs that were received through Download for z/OS or AFP Download Plus.
print_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.print_properties.cfg.csv audit file. The control file causes RICOH ProcessDirector to record information that is specific to the printing step for the job. It records the values of print-related properties, such as the duplex mode for the job and the name of the printer that printed the job. If the workflow for the job does not specify a print step, RICOH ProcessDirector records only the job number for the job in the audit file.

The AFP Support feature provides these control files for job-audit information:

line2afp_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.line2afp_properties.cfg.csv audit file. The control file causes RICOH ProcessDirector to record information that is specific to line data jobs that it converts to the AFP format. RICOH ProcessDirector records the values of line2afp command parameters, such as CHARS and IMAGEOUT. If RICOH ProcessDirector does not use the line2afp command to process the job, it records only the job number for the job in the audit file.
transform_properties.cfg
This control file defines the content of the jobnumber.yy-mm-dd_hh-mm-ss.transform_properties.cfg audit file. The control file causes RICOH ProcessDirector to record information that is specific to processing that is done through the RICOH ProcessDirector user interface by a RICOH ProcessDirector Transform feature or InfoPrint Transform Manager. It records the values of transform-related properties, such as page width and page length specifications. If the workflow for the job does not specify an external step for the transform, RICOH ProcessDirector records only the job number for the job in the audit file.

Note: RICOH ProcessDirector also writes audit information about other types of objects, such as input devices. It writes the information to files in separate subdirectories of C:\aiw\aiw1\audit, and the audit information consists of messages that pertain to the object. For example, the messages might record changes to property values. RICOH ProcessDirector does not provide control files to control the content of audit files for object types other than jobs.

Related information:

RICOH ProcessDirector symbol notation
WriteJobLog
Logging job information before the job completes
Directory structure
Directory structure
Configuring control files for job audit information
Parent topic: Syntax for RICOH ProcessDirector control files