getControlFileName syntax

The getControlFileName method returns the name of the resolved control file for the job. The method uses no parameters. Authorized users must always use this format for the method:


getControlFileName example

This example uses a spool directory of /aiw/aiw1/spool/default/10000003 on AIX or Linux and C:\aiw\aiw1\spool\default\10000003 on Windows and describes how Ricoh ProcessDirector creates files and generates values when you use the getControlFileName method.

A workflow contains an external step in the Prepare phase that specifies these properties and values:

External control file template [Prepare][RunExternalProgram]
Value: /aiw/aiw1/control_files/external_programs/job_info.cfg on AIX or Linux or C:\aiw\aiw1\control_files\external_programs\job_info.cfg on Windows
External command [Prepare][RunExternalProgram]
Value: cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv on AIX or Linux or copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv on Windows

Just before running the external step, Ricoh ProcessDirector copies the external control file template to the tmp subdirectory of the spool directory and resolves any symbols that the control file template contains. This is the procedure that Ricoh ProcessDirector uses to create the resulting control file. For example, it generates this file on AIX or Linux:

And this file on Windows:

When Ricoh ProcessDirector creates the job that uses the workflow and sets its initial property values, it uses the value that the getControlFileName method returned to resolve the external command to this on AIX on Linux:

cp /aiw/aiw1/spool/default/10000003/tmp/job_info.control.text /aiw/aiw1/samples/

Or, on Windows, to this:

copy C:\aiw\aiw1\spool\default\10000003\tmp\job_info.control.text C:\aiw\aiw1\samples\