getControlFileName syntax

${getControlFileName()}

getControlFileName example

This example uses this spool directory:

• /aiw/aiw1/spool/default/10000003(Linux)
• C:\aiw\aiw1\spool\default\10000003(Windows)

It 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(Linux)
• C:\aiw\aiw1\control_files\external_programs\job_info.cfg(Windows)

External command [Prepare][RunExternalProgram]

Value:

• cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv(Linux)
• copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv(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: For example, it generates this file on Linux:

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

And this file on Windows:

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

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. The command is:

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

Or, on Windows, to this:

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