getControlFileName syntax
The method uses no parameters. Always use this format for the method:
${getControlFileName()}
getControlFileName example
This example uses this spool directory:
/aiw/aiw1/spool/default/10000003
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
- External command [Prepare][RunExternalProgram]
- Value:
cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv
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:
/
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